AS7 Resource Description

root

The root node of the server-level management model.

Attributes

namespaces

Map of namespaces used in the configuration XML document, where keys are namespace prefixes and values are schema URIs.

schema-locations

Map of locations of XML schemas used in the configuration XML document, where keys are schema URIs and values are locations where the schema can be found.

name

The name of this server. If not set, defaults to the runtime value of InetAddress.getLocalHost().getHostName().

release-version

The version of the JBoss Application Server release this server is running.

release-codename

The codename of the JBoss Application Server release this server is running.

product-name

The name of the JBoss AS based product that is being run by this server.

product-version

The version of the JBoss AS based product release that is being run by this server.

management-major-version

The major version of the JBoss AS management interface that is provided by this server.

management-minor-version

The minor version of the JBoss AS management interface that is provided by this server.

management-micro-version

The micro version of the JBoss AS management interface that is provided by this server.

profile-name

The name of the server's configuration profile.

server-state

The current state of the server controller; either STARTING, RUNNING or RESTART_REQUIRED

process-type

The type of process represented by this root resource. Always has a value of "Server" for a server resource.

launch-type

The manner in which the server process was launched. Either "DOMAIN" for a domain mode server launched by a Host Controller, "STANDALONE" for a standalone server launched from the command line, or "EMBEDDED" for a standalone server launched as an embedded part of an application running in the same virtual machine.

Operations

remove-namespace

Removes a namespace prefix mapping from the namespaces attribute's map.

Request properties

Returns

Returned type:

read-operation-description

Gets the details of an operation on the given resource

Request properties

Returns The description of the operation. Undefined if not found

Returned type: OBJECT

resolve-expression

Operation that accepts an expression as input (or a string that can be parsed into an expression) and resolves it against the local system properties and environment variables.

Request properties

Returns The resolved expression, or the string form of the original input value if it did not represent an expression.

Returned type: STRING

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

remove-schema-location

Removes a schema location mapping from the schema-locations attribute's map.

Request properties

Returns

Returned type:

validate-address

Checks whether a resource with the address passed in as the argument exists.

Request properties

Returns Report of checking the address.

Returned type: OBJECT

read-attribute

Gets the value of an attribute for the selected resource

Request properties

Returns The value of the attribute. The type will be that of the attribute found

Returned type: OBJECT

full-replace-deployment

Add previously uploaded deployment content to the list of content available for use, replace existing content of the same name in the runtime, and remove the replaced content from the list of content available for use. This is equivalent to an 'add', 'undeploy', 'deploy', 'remove' sequence where the new content has the same name as the content being replaced. Precisely one of 'runtime-name', 'hash', 'input-stream-index', 'bytes' or 'url' must be specified.

Request properties

Returns

Returned type:

shutdown

Shuts down the server via a call to System.exit(0)

Request properties

Returns

Returned type:

read-children-names

Gets the names of all children under the selected resource with the given type

Request properties

Returns The children names

Returned type: LIST

upload-deployment-stream

Indicates that the deployment content available at the included input stream index should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request properties

Returns The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

Returned type: BYTES

read-resource-description

Gets the description of a resource's attributes, types of children and, optionally, operations

Request properties

Returns The description of the resource

Returned type: OBJECT

resolve-internet-address

Takes a set of interface resolution criteria and finds an IP address on the local machine that matches the criteria, or fails if no matching IP address can be found.

Request properties

Returns The IP address string in textual presentation.

Returned type: STRING

upload-deployment-url

Indicates that the deployment content available at the included URL should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request properties

Returns The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

Returned type: BYTES

add-schema-location

Adds a schema location mapping to the schema-locations attribute's map.

Request properties

Returns

Returned type:

delete-snapshot

Deletes a snapshot from the snapshots directory

Request properties

Returns

Returned type:

upload-deployment-bytes

Indicates that the deployment content in the included byte array should be added to the deployment content repository. Note that this operation does not indicate the content should be deployed into the runtime.

Request properties

Returns The hash of managed deployment content that has been uploaded to the domain's or standalone server's deployment content repository.

Returned type: BYTES

whoami

Returns the identity of the currently authenticated user.

Request properties

Returns

Returned type:

read-operation-names

Gets the names of all the operations for the given resource

Request properties

Returns The operation names

Returned type: LIST

read-children-types

Gets the type names of all the children under the selected resource

Request properties

Returns The children types

Returned type: LIST

take-snapshot

Takes a snapshot of the current configuration

Request properties

Returns The location of the file on the machine the configuration belongs

Returned type: STRING

undefine-attribute

Sets the value of an attribute of the selected resource to 'undefined'

Request properties

Returns

Returned type:

read-config-as-xml

Reads the current configuration and returns it in XML format.

Request properties

Returns The XML form of the persistent configuration.

Returned type: STRING

read-children-resources

Reads information about all of a resource's children that are of a given type

Request properties

Returns The children resources

Returned type: LIST

add-namespace

Adds a namespace prefix mapping to the namespaces attribute's map.

Request properties

Returns

Returned type:

list-snapshots

Lists the snapshots

Request properties

Returns

Returned type: OBJECT

replace-deployment

Replace existing content in the runtime with new content. The new content must have been previously uploaded to the deployment content repository.

Request properties

Returns

Returned type:

server-set-restart-required

Puts the server into a restart-required mode.

Request properties

Returns

Returned type:

write-attribute

Sets the value of an attribute for the selected resource

Request properties

Returns

Returned type:

reload

Reloads the server by shutting down all its services and starting again. The JVM itself is not restarted.

Request properties

Returns

Returned type:

validate-operation

Validates that an operation is valid according to its description. Any errors present will be shown in the operation's failure-description.

Request properties

Returns

Returned type:

extension

A list of extension modules.

*

A module that extends the standard capabilities of a domain or a standalone server.

Attributes

module

The name of the module.

Operations

remove

Removes an extension.

Request properties

Returns

Returned type:

add

Adds an extension.

Request properties

Returns

Returned type:

subsystem

A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.

*

A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.

Attributes

management-major-version

Major version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

management-micro-version

Micro version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

xml-namespaces

A list of URIs for the XML namespaces supported by the subsystem's XML parser. May be empty if the extension did not clearly associate an XML namespace with a particular subsystem.

management-minor-version

Minor version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

path

A list of named filesystem paths.

*

A named filesystem path.

Attributes

name

The name of the path. Cannot be one of the standard fixed paths provided by the system:

Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

read-only

True if added by the system, false if configured by user. If true, the path cannot be removed or modified.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path

Request properties

Returns

Returned type:

add

Add a new path.

Request properties

Returns

Returned type:

system-property

A list of system properties to set on the server.

*

A system property to set on the server.

Attributes

value

The value of the system property.

Operations

remove

Removes a system property.

Request properties

Returns

Returned type:

add

Adds a system property or updates an existing one.

Request properties

Returns

Returned type:

core-service

Core services provided by the server.

service-container

The central container that manages all services in a running standalone server or in a host controller in a management domain.

Operations

dump-services

Dumps all services running in the container, including their status and dependency information.

Request properties

Returns

Returned type: STRING

vault

Security Vault for attributes.

Attributes

code

Fully Qualified Name of the Security Vault Implementation.

vault-options

Security Vault options.

Operations

remove

Remove the Security Vault.

Request properties

Returns

Returned type:

add

Add the Security Vault.

Request properties

Returns

Returned type:

server-environment

The server environment.

Attributes

config-file

The configuration file used to launch JBoss Application Server.

initial-running-mode

The current running mode of the server. Either LIVE (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.

ext-dirs

A list of ext directories.

content-dir

The directory where user content (e.g. deployments) that is managed by the server is stored.

log-dir

The directory where log files are sent.

temp-dir

The temporary directory.

data-dir

The data directory.

node-name

The name of the server node.

deploy-dir

Deprecated variant of 'content-dir'.

base-dir

The base directory for JBoss Application Server.

home-dir

The home directory for JBoss Application Server.

host-name

The host name.

launch-type

The type of the running server.

modules-dir

The directory where modules are found.

qualified-host-name

The qualified host name.

config-dir

The directory where the configurations are stored.

server-name

The name of the server.

platform-mbean

Provides the management interface for monitoring and management of the Java virtual machine as well as the operating system on which the Java virtual machine is running. Exposes the JDK-provided JMX MBeans in the java.lang, java.nio and java.util.logging JMX domains.

Attributes

Operations

type

The platform MBeans, organized by the value of the 'type' property in the MBean's ObjectName.

compilation

The management interface for the compilation system of the Java virtual machine

Attributes

name

The name of the Just-in-time (JIT) compiler.

compilation-time-monitoring-supported

Whether the Java virtual machine supports the monitoring of compilation time.

total-compilation-time

The approximate accumulated elapsed time (in milliseconds) spent in compilation. A Java virtual machine implementation may not support compilation time monitoring. If "compilation-time-monitoring-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

object-name

String representation the object name of this platform managed object.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

memory-manager

Parent resource for the resources providing the management interface for the Java virtual machine's memory managers.

Attributes

Operations

name

The MemoryManagerMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a memory manager. A memory manager manages one or more memory pools of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing this memory manager.

valid

Whether this memory manager is valid in the Java virtual machine.

memory-pool-names

The names of the memory pools that this memory manager manages.

Operations

garbage-collector

Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.

Attributes

Operations

name

The GarbageCollectorMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for one of the garbage collectors in the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing this garbage collector.

valid

Whether this this memory manager is valid in the Java virtual machine.

memory-pool-names

The name of memory pools that this garbage collector manages.

collection-count

The total number of collections that have occurred.

collection-time

The approximate accumulated collection elapsed time in milliseconds.

Operations

memory

The management interface for the memory system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

verbose

Whether verbose output for the memory system is enabled.

object-pending-finalization-count

The approximate number of objects for which finalization is pending.

heap-memory-usage

The current memory usage of the heap that is used for object allocation.

non-heap-memory-usage

The current memory usage of non-heap memory that is used by the Java virtual machine.

Operations

gc

Runs the garbage collector.

Request properties

Returns

Returned type:

threading

The management interface for the thread system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

thread-contention-monitoring-enabled

Whether thread contention monitoring is enabled.

thread-cpu-time-enabled

Whether thread CPU time measurement is enabled.

all-thread-ids

All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

thread-contention-monitoring-supported

Whether the Java virtual machine supports thread contention monitoring.

thread-cpu-time-supported

Whether the Java virtual machine implementation supports CPU time measurement for any thread.

current-thread-cpu-time-supported

Whether the Java virtual machine supports CPU time measurement for the current thread.

object-monitor-usage-supported

Whether the Java virtual machine supports monitoring of object monitor usage.

synchronizer-usage-supported

Whether the Java virtual machine supports monitoring of ownable synchronizer usage.

thread-count

The current number of live threads including both daemon and non-daemon threads.

peak-thread-count

The peak live thread count since the Java virtual machine started or peak was reset.

total-started-thread-count

The total number of threads created and also started since the Java virtual machine started.

daemon-thread-count

The current number of live daemon threads.

current-thread-cpu-time

The total CPU time for the current thread in nanoseconds, or -1 if "thread-cpu-time-enabled" is "false". A Java virtual machine implementation may not support CPU time measurement. If "thread-cpu-time-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

current-thread-user-time

The CPU time that the current thread has executed in user mode in nanoseconds, or -1 if "thread-cpu-time-enabled" is "false". A Java virtual machine implementation may not support CPU time measurement. If "thread-cpu-time-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

Operations

get-thread-infos

Returns the thread info for each thread whose ID is in the input list.

Request properties

Returns A list of detyped representations of java.lang.management.ThreadInfo objects, each containing information about a thread whose ID is in the corresponding element of the input list of IDs. An element will be "undefined" if the thread of the given ID is not alive or it does not exist.

Returned type: LIST

get-thread-cpu-time

Returns the total CPU time for a thread of the specified ID in nanoseconds.

Request properties

Returns

Returned type: LONG

find-monitor-deadlocked-threads

Finds cycles of threads that are in deadlock waiting to acquire object monitors.

Request properties

Returns A list of thread ids of deadlocked threads, if any, or "undefined" otherwise.

Returned type: LIST

reset-peak-thread-count

Resets the peak thread count to the current number of live threads.

Request properties

Returns

Returned type:

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

dump-all-threads

Returns the thread info for all live threads with stack trace and synchronization information.

Request properties

Returns A list of detyped representations of java.lang.management.ThreadInfo objects.

Returned type: LIST

get-thread-user-time

Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.

Request properties

Returns

Returned type: LONG

find-deadlocked-threads

Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.

Request properties

Returns A list of thread ids of deadlocked threads, if any, or "undefined" otherwise.

Returned type: LIST

get-thread-info

Returns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.

Request properties

Returns Detyped representation of a java.lang.management.ThreadInfo object for the thread of the given ID; "undefined" if the thread of the given ID is not alive or it does not exist.

Returned type: OBJECT

operating-system

The management interface for the operating system on which the Java virtual machine is running.

Attributes

object-name

String representation the object name of this platform managed object.

name

The operating system name. If a security manager is installed and it does not allow access to system property "os.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

arch

The operating system architecture. If a security manager is installed and it does not allow access to system property "os.arch", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

version

The operating system version. If a security manager is installed and it does not allow access to system property "os.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

available-processors

The number of processors available to the Java virtual machine.

system-load-average

The system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

buffer-pool

Parent resource for the resources providing the management interface for the Java virtual machine's buffer pools.

Attributes

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

Operations

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a buffer pool, for example a pool of direct or mapped buffers.

Attributes

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

count

An estimate of the number of buffers in the pool.

memory-used

An estimate of the memory that the Java virtual machine is using for this buffer pool in bytes, or -1 if an estimate of the memory usage is not available.

total-capacity

An estimate of the total capacity of the buffers in this pool. A buffer's capacity is the number of elements it contains and the value of this attribute is an estimate of the total capacity of buffers in the pool in bytes.

object-name

String representation the object name of this platform managed object.

Operations

memory-pool

Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.

Attributes

Operations

name

The MemoryPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.

Attributes

object-name

String representation the object name of this platform managed object.

usage-threshold

The usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold

The collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

name

The name representing this memory pool.

type

The type of this memory pool.

valid

Whether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.

memory-manager-names

The names of the memory managers that manage this memory pool.

usage-threshold-supported

Whether this memory pool supports usage threshold.

collection-usage-threshold-supported

Whether this memory pool supports a collection usage threshold.

usage

An estimate of the memory usage of this memory pool. May be "undefined" if attribute "valid" is "false".

peak-usage

The peak memory usage of this memory pool since the Java virtual machine was started or since the peak was reset. May be "undefined" if attribute "valid" is "false".

usage-threshold-exceeded

Whether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

usage-threshold-count

The number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold-exceeded

Whether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold-count

The number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage

The memory usage after the Java virtual machine most recently expended effort in recycling unused objects in this memory pool, or "undefined" if this attribute is not supported.

Operations

reset-peak-usage

Resets the peak memory usage statistic of this memory pool to the current memory usage.

Request properties

Returns

Returned type:

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

runtime

The management interface for the runtime system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing the running Java virtual machine.

vm-name

The Java virtual machine implementation name. If a security manager is installed and it does not allow access to system property "java.vm.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

vm-vendor

The Java virtual machine implementation vendor. If a security manager is installed and it does not allow access to system property "java.vm.vendor", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

vm-version

The Java virtual machine implementation version. If a security manager is installed and it does not allow access to system property "java.vm.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-name

The Java virtual machine specification name. If a security manager is installed and it does not allow access to system property "java.vm.specification.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-vendor

The Java virtual machine specification vendor. If a security manager is installed and it does not allow access to system property "java.vm.specification.vendor", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-version

The Java virtual machine specification version. If a security manager is installed and it does not allow access to system property "java.vm.specification.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

management-spec-version

The version of the specification for the management interface implemented by the running Java virtual machine.

class-path

The Java class path that is used by the system class loader to search for class files. If a security manager is installed and it does not allow access to system property "java.class.path", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

library-path

The Java library path. If a security manager is installed and it does not allow access to system property "java.library.path", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

boot-class-path-supported

Whether the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.

boot-class-path

The boot class path that is used by the bootstrap class loader to search for class files. If attribute "boot-class-path-supported" is "false" or if a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

input-arguments

The input arguments passed to the Java virtual machine which does not include the arguments to the main method. If a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

start-time

The start time of the Java virtual machine in milliseconds.

system-properties

A map of names and values of all system properties. If a security manager is installed and its "checkPropertiesAccess" method does not allow access to system properties, then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

uptime

The uptime of the Java virtual machine in milliseconds.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

class-loading

The management interface for the class loading system of the Java virtual machine.

Attributes

verbose

Whether the verbose output for the class loading system is enabled.

total-loaded-class-count

The total number of classes that have been loaded since the Java virtual machine has started execution.

loaded-class-count

The number of classes that are currently loaded in the Java virtual machine.

unloaded-class-count

The total number of classes unloaded since the Java virtual machine has started execution.

object-name

String representation the object name of this platform managed object.

Operations

management

The management services used to control a standalone server or a host's host controller in a management domain.

Operations

security-realm

The security realms available for control access to the management services.

*

A security realm that can be associated with a management interface and used to control access to the management services.

Attributes

Operations

remove

Removes a security realm that can be associated with a management interface and used to control access to the management services.

Request properties

Returns

Returned type:

add

Adds a security realm that can be associated with a management interface and used to control access to the management services.

Request properties

Returns

Returned type:

authentication

Configuration of the server side authentication mechanisms. Optionally one truststore can be defined and one username/password based store can be defined. Authentication will first attempt to use the truststore and if this is not available will fall back to the username/password authentication. If none of these are specified the only available mechanism will be the local mechanism for the Native interface and the HTTP interface will not be accessible.

jaas

Configuration to use a JAAS LoginContext to authenticate the users.

Attributes

name

The name of the JAAS configuration to use.

Operations

remove

Removes a configuration to use JAAS for authentication.

Request properties

Returns

Returned type:

add

Adds a configuration to use JAAS for authentication.

Request properties

Returns

Returned type:

local

Configuration of the local authentication mechanism.

Attributes

default-user

The name of the default user to assume if no user specified by the remote client.

allowed-users

The comma separated list of users that will be accepted using the JBOSS-LOCAL-USER mechanism or '*' to accept all. If specified the default-user is always assumed allowed.

Operations

remove

Removes a configuration to use JBOSS-LOCAL-USER for authentication.

Request properties

Returns

Returned type:

add

Adds a configuration to use the JBOSS-LOCAL-USER mechanism for authentication.

Request properties

Returns

Returned type:

plug-in

Configuration of a user store plug-in for use by the realm.

Attributes

mechanism

Allow the mechanism this plug-in is compatible with to be overridden from DIGEST.

name

The short name of the plug-in (as registered) to use.

Operations

remove

Configuration of a user store plug-in for use by the realm.

Request properties

Returns

Returned type:

add

Add the plug-in definition.

Request properties

Returns

Returned type:

property

A configuration property to be made available to the plug-in.

*

A property within a security realm resource.

Attributes

value

The optional value of the property.

Operations

remove

Remove the property definition.

Request properties

Returns

Returned type:

add

Add a property definition.

Request properties

Returns

Returned type:

ldap

Configuration to use LDAP as the user repository.

Attributes

connection

The name of the connection to use to connect to LDAP.

advanced-filter

The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

base-dn

The base distinguished name to commence the search for the user.

user-dn

The name of the attribute which is the user's distinguished name.

recursive

Whether the search should be recursive.

username-attribute

The name of the attribute to search for the user. This filter will then perform a simple search where the username entered by the user matches the attribute specified here.

Operations

remove

Removes a configuration to use LDAP as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use LDAP as the user repository.

Request properties

Returns

Returned type:

truststore

Configuration of a keystore to use to create a trust manager to verify clients.

Attributes

keystore-password

The password to open the keystore.

keystore-path

The path of the keystore.

keystore-relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a keystore to use to create a trust manager to verify clients.

Request properties

Returns

Returned type:

add

Adds a keystore to use to create a trust manager to verify clients.

Request properties

Returns

Returned type:

properties

Configuration to use a list users stored within a properties file as the user repository. The entries within the properties file are username={credentials} with each user being specified on it's own line.

Attributes

path

The path of the properties file containing the users.

plain-text

Are the credentials within the properties file stored in plain text. If not the credential is expected to be the hex encoded Digest hash of 'username : realm : password'.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a configuration to use a list users stored within a properties file as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use a list users stored within a properties file as the user repository.

Request properties

Returns

Returned type:

users

Configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Attributes

Operations

remove

Removes a configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Request properties

Returns

Returned type:

user

An authorized user.

*

An authorized user.

Attributes

password

The user's password.

Operations

remove

Removes an authorized user.

Request properties

Returns

Returned type:

add

Adds an authorized user.

Request properties

Returns

Returned type:

server-identity

Configuration of the identities that represent the server.

ssl

Configuration of the SSL identity of a server or host controller.

Attributes

protocol

The protocol to use when creating the SSLContext.

keystore-relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

alias

The alias of the entry to use from the keystore.

key-password

The password to obtain the key from the keystore.

keystore-password

The password to open the keystore.

keystore-path

The path of the keystore.

Operations

remove

Removes the SSL identity of a server or host controller.

Request properties

Returns

Returned type:

add

Adds the SSL identity of a server or host controller.

Request properties

Returns

Returned type:

secret

Configuration of the secret/password-based identity of a server or host controller.

Attributes

value

The secret / password - Base64 Encoded.

Operations

remove

Removes a Adds a secret/password-based identity for a server or host controller.

Request properties

Returns

Returned type:

add

Adds a secret/password-based identity for a server or host controller.

Request properties

Returns

Returned type:

authorization

Configuration server side for loading additional user information such as roles to be used for subsequent authorization checks.

properties

Configuration to use properties file to load a users roles. The entries within the properties file are username={roles} where roles is a comma separated list of users roles.

Attributes

path

The path of the properties file containing the users roles.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a configuration to use a properties file to load a users roles.

Request properties

Returns

Returned type:

add

Adds a configuration to use a properties file to load a users roles.

Request properties

Returns

Returned type:

plug-in

Configuration of a user store plug-in for use by the realm.

Attributes

name

The short name of the plug-in (as registered) to use.

Operations

remove

Configuration of a user store plug-in for use by the realm.

Request properties

Returns

Returned type:

add

Add the plug-in definition.

Request properties

Returns

Returned type:

property

A configuration property to be made available to the plug-in.

*

A property within a security realm resource.

Attributes

value

The optional value of the property.

Operations

remove

Remove the property definition.

Request properties

Returns

Returned type:

add

Add a property definition.

Request properties

Returns

Returned type:

plug-in

An extension to the security realm allowing additional authentication / authorization modules to be loaded.

*

An extension to the security realm allowing additional authentication / authorization modules to be loaded.

Attributes

Operations

remove

Remove a plug-in from the security realm.

Request properties

Returns

Returned type:

add

Add a plug-in to the security realm.

Request properties

Returns

Returned type:

ldap-connection

Configurations of connection factories that can be used by a security realm to access LDAP servers as a source of authentication and authorization information.

*

A connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.

Attributes

initial-context-factory

The initial context factory to establish the LdapContext.

search-credential

The credential to use when connecting to perform a search.

url

The URL to use to connect to the LDAP server.

search-dn

The distinguished name to use when connecting to the LDAP server to perform searches.

Operations

remove

Removes a connection factory that was usable by a security realm to access an LDAP server as a source of authentication and authorization information.

Request properties

Returns

Returned type:

add

Adds a connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.

Request properties

Returns

Returned type:

management-interface

Interfaces exposed by the management services to allow external callers to perform management tasks.

native-interface

Configuration of the server's native management interface

Attributes

port

Deprecated -- use 'socket-binding'. The port on which the server's socket for native management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

interface

Deprecated -- use 'socket-binding'. The network interface on which the server's socket for native management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

security-realm

The security realm to use for the native management interface.

socket-binding

The name of the socket binding configuration to use for the native management interface's socket.

Operations

remove

Removes the server's native management interface

Request properties

Returns

Returned type:

add

Adds the server's native management interface

Request properties

Returns

Returned type:

http-interface

Configuration of the server's HTTP management interface

Attributes

port

Deprecated -- use 'socket-binding'. The port on which the server's socket for HTTP management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

console-enabled

Flag that indicates admin console is enabled

secure-port

Deprecated -- use 'secure-socket-binding'. The port on which the server's socket for HTTPS management communication should be opened. Must be 'undefined' if the 'socket-binding' or 'secure-socket-binding' attribute is set.

interface

Deprecated -- use 'socket-binding'. The network interface on which the server's socket for HTTP management communication should be opened. Must be 'undefined' if the 'socket-binding' or 'secure-socket-binding' attribute is set.

security-realm

The security realm to use for the HTTP management interface.

socket-binding

The name of the socket binding configuration to use for the HTTP management interface's socket.

secure-socket-binding

The name of the socket binding configuration to use for the HTTPS management interface's socket.

Operations

remove

Adds the configuration of the server's HTTP management interface

Request properties

Returns

Returned type:

add

Adds the configuration of the server's HTTP management interface

Request properties

Returns

Returned type:

native-remoting-interface

Configuration of the server's native management interface using a connector from the remoting subsystem.

Attributes

Operations

remove

Removes the server's native management interface using a connector from the remoting subsystem.

Request properties

Returns

Returned type:

add

Adds the server's native management interface using a connector from the remoting subsystem.

Request properties

Returns

Returned type:

interface

A list of named network interfaces available for use on the server.

*

A named network interface, along with required criteria for determining the IP address to associate with that interface.

Attributes

name

The name of the interface.

any-address

Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.

any-ipv4-address

Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0).

any-ipv6-address

Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::).

inet-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.

link-local-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

loopback

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

loopback-address

Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

multicast

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

nic

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.

nic-match

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.

point-to-point

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

public-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

site-local-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

subnet-match

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in "slash notation"; e.g. "192.168.0.0/16". An 'undefined' value means this attribute is not relevant to the IP address selection.

up

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

virtual

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

any

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address meets at least one of a nested set of criteria, but not necessarily all of the nested criteria. The value of the attribute is a set of criteria. An 'undefined' value means this attribute is not relevant to the IP address selection.

not

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address *does not* meet any of a nested set of criteria. The value of the attribute is a set of criteria (e.g. 'loopback') whose normal meaning is reversed. An 'undefined' value means this attribute is not relevant to the IP address selection.

Operations

remove

Remove an interface specification.

Request properties

Returns

Returned type:

resolve-internet-address

Takes a set of interface resolution criteria and finds an IP address on the local machine that matches the criteria, or fails if no matching IP address can be found.

Request properties

Returns The IP address string in textual presentation.

Returned type: STRING

add

Add a new interface specification.

Request properties

Returns

Returned type:

socket-binding-group

A list of socket bindings available for use on the server.

*

Contains a list of socket configurations.

Attributes

port-offset

Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.

default-interface

Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.

name

The name of the socket binding group.

Operations

remove

Removes a socket binding group.

Request properties

Returns

Returned type:

add

Adds a socket binding group.

Request properties

Returns

Returned type:

socket-binding

Configuration information for a socket.

*

Configuration information for a socket.

Attributes

port

Number of the port to which the socket should be bound.

bound-port

The port to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.

interface

Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.

fixed-port

Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.

client-mappings

Specifies zero or more client mappings for this socket binding. A client connecting to this socket should use the destination address specified in the mapping that matches its desired outbound interface. This allows for advanced network topologies that use either network address translation, or have bindings on multiple network interfaces to function. Each mapping should be evaluated in declared order, with the first successful match used to determine the destination.

multicast-port

Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.

bound-address

The address to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.

name

The name of the socket. Services which need to access the socket configuration information will find it using this name.

multicast-address

Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.

bound

Whether an actual socket using this socket binding configuration has been bound.

Operations

remove

Removes a socket binding configuration from the group.

Request properties

Returns

Returned type:

add

Adds a socket binding configuration to the group.

Request properties

Returns

Returned type:

remote-destination-outbound-socket-binding

Configuration information for a, remote destination, outbound socket binding.

*

Configuration information for a, remote destination, outbound socket binding.

Attributes

port

The port number of the remote destination to which the outbound socket should connect.

host

The host name or the IP address of the remote destination to which this outbound socket will connect.

source-interface

The name of the interface which will be used for the source address of the outbound socket.

source-port

The port number which will be used as the source port of the outbound socket.

fixed-source-port

Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.

Operations

remove

Removes a remote destination outbound socket binding, from a socket binding group

Request properties

Returns

Returned type:

add

Adds a remote destination outbound socket binding, to a socket binding group

Request properties

Returns

Returned type:

local-destination-outbound-socket-binding

Configuration information for a, local destination, outbound socket binding.

*

Configuration information for a, local destination, outbound socket binding.

Attributes

source-port

The port number which will be used as the source port of the outbound socket.

source-interface

The name of the interface which will be used for the source address of the outbound socket.

fixed-source-port

Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.

socket-binding-ref

The name of the local socket-binding which will be used to determine the port to which this outbound socket connects.

Operations

remove

Removes a local destination outbound socket binding, from a socket binding group

Request properties

Returns

Returned type:

add

Adds a local destination outbound socket binding, to a socket binding group

Request properties

Returns

Returned type:

deployment

A list of deployments available for use on the server.

*

A deployment represents anything that can be deployed (e.g. an application such as EJB-JAR, WAR, EAR, any kind of standard archive such as RAR or JBoss-specific deployment) into a server.

Attributes

name

Unique identifier of the deployment. Must be unique across all deployments.

runtime-name

Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.

content

List of pieces of content that comprise the deployment.

enabled

Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)

persistent

Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.

status

The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.

Operations

redeploy

Undeploy existing content from the runtime and deploy it again.

Request properties

Returns

Returned type:

remove

Remove a deployment from the list of content available for use. If the deployment is currently deployed in the runtime it will first be undeployed.

Request properties

Returns

Returned type:

undeploy

Undeploy content from the runtime. The content remains in the list of content available for use.

Request properties

Returns

Returned type:

deploy

Deploy the specified deployment content into the runtime, optionally replacing existing content.

Request properties

Returns

Returned type:

add

Adds previously uploaded content to the list of content available for use. Does not actually deploy the content unless the 'enabled' parameter is 'true'.

Request properties

Returns

Returned type:

subsystem

Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.

web

Runtime resources exposed by web components in the deployment.

Attributes

expired-sessions

Number of sessions that have expired

rejected-sessions

Number of rejected sessions

max-active-sessions

Max number of concurrent active sessions

session-max-alive-time

The longest time (in seconds) that an expired session had been alive

sessions-created

Total sessions created

session-avg-alive-time

Average time (in seconds) that expired sessions had been alive

context-root

The context root of the web application

virtual-host

The name of the virtual host on which the web application is served

active-sessions

Number of active sessions

duplicated-session-ids

Number of duplicated session IDs generated by the random source (anything bigger than 0 means problems)

servlet

Runtime information about the servlets in the deployment.

*

Runtime information about the servlets in the deployment.

Attributes

min-time

Minimum processing time of a request

load-time

Load time

processingTime

Total execution time of the servlet's service method

maxTime

Maximum processing time of a request

requestCount

Number of requests processed by this servlet

datasources

Runtime resources exposed by data sources included in this deployment.

Attributes

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

data-source

A JDBC data-source configuration

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

messaging

Runtime resources exposed by messaging resources included in this deployment.

Attributes

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

path

webservices

Runtime resources exposed by web service components in the deployment.

Attributes

endpoint

Webservice endpoint.

*

Webservice endpoint.

Attributes

name

Webservice endpoint name.

context

Webservice endpoint context.

class

Webservice endpoint class.

type

Webservice endpoint type.

wsdl-url

Webservice endpoint WSDL URL.

average-processing-time

Average endpoint processing time.

min-processing-time

Minimal endpoint processing time.

max-processing-time

Maximal endpoint processing time.

total-processing-time

Total endpoint processing time.

request-count

Count of requests the endpoint processed.

response-count

Count of responses the endpoint generated.

fault-count

Count of faults the endpoint generated.

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

hibernate-persistence-unit

Persistence unit

*

Runtime information about Hibernate use in the deployment.

Attributes

entity-delete-count

Get number of entity deletes.

entity-insert-count

Get number of entity inserts.

entity-load-count

Get number of entity loads.

entity-fetch-count

Get number of entity fetches.

entity-update-count

Get number of entity updates.

query-execution-count

Get number of executed queries.

query-execution-max-time

Get the time in milliseconds of the slowest query.

query-execution-max-time-query-string

Get the query string for the slowest query.

query-cache-hit-count

Get the number of cached queries successfully retrieved from cache.

query-cache-miss-count

Get the number of cached queries not found in cache.

query-cache-put-count

Get the number of cacheable queries put in cache.

flush-count

Get the number of flushes executed by sessions (either implicit or explicit).

connect-count

Get the number of connections asked for by the sessions.

second-level-cache-hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

second-level-cache-miss-count

Number of cacheable entities/collections not found in the cache and loaded.

second-level-cache-put-count

Number of cacheable entities/collections put in the cache.

session-close-count

Number of sessions closed.

session-open-count

Number of sessions opened.

collection-load-count

Number of collections loaded.

collection-fetch-count

Number of collections fetched.

collection-update-count

Number of collections updated.

collection-remove-count

Number of collections removed.

collection-recreated-count

Number of collections recreated.

successful-transaction-count

Number of successful transactions.

completed-transaction-count

Number of completed transactions.

prepared-statement-count

Number of acquired prepared statements.

close-statement-count

Number of released prepared statements.

optimistic-failure-count

Number of optimistic lock exceptions.

enabled

Determine if statistics are enabled.

Operations

summary

Log the statistics.

Request properties

Returns

Returned type:

clear

Clear statistics.

Request properties

Returns

Returned type:

evict-all

Evict all entities from second level cache.

Request properties

Returns

Returned type:

entity-cache

Statistics for a Hibernate Second Level Cache region.

*

Statistics for a Hibernate Second Level Cache region.

Attributes

miss-count

Number of cacheable entities/collections not found in the cache and loaded.

put-count

Number of cacheable entities/collections put in the cache.

element-count-in-memory

Number of cacheable entities/collections currently stored in memory.

hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

query-cache

Statistics for individual queries.

*

Statistics for individual queries.

Attributes

query-execution-count

Get number of times query has been executed.

query-execution-max-time

Get the time in milliseconds of the query.

query-execution-min-time

Get the minimum time in milliseconds of the query.

query-name

Query name.

query-execution-average-time

Get the average time in milliseconds of the query.

query-cache-miss-count

Get the number of times query was not found in cache.

query-execution-row-count

Get number of rows returned from executions of query.

query-cache-hit-count

Get the number of times query was retrieved from cache.

query-cache-put-count

Get the number of times query was put in cache.

entity

Statistics for individual entities.

*

Statistics for individual entities.

Attributes

entity-load-count

Get number of entity loads.

entity-update-count

Get number of entity updates.

optimistic-failure-count

Number of optimistic lock exceptions.

entity-fetch-count

Get number of entity fetches.

entity-insert-count

Get number of entity inserts.

entity-delete-count

Get number of entity deletes.

collection

Statistics for individual collections.

*

Statistics for individual collections.

Attributes

collection-fetch-count

Number of times collection was fetched.

collection-recreated-count

Number of times collection was recreated.

collection-load-count

Number of times collection was loaded.

collection-update-count

Number of times collection was updated.

collection-remove-count

Number of times collection was removed.

ejb3

Runtime resources exposed by EJBs components included in this deployment.

Attributes

message-driven-bean

Message driven bean component included in the deployment.

*

Message driven bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

singleton-bean

Singleton bean component included in the deployment.

*

Singleton bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

timers

EJB timers associated with the component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

stateless-session-bean

Stateless session bean component included in the deployment.

*

Stateless session bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

entity-bean

Entity bean component included in the deployment.

*

Entity bean component included in the deployment.

Attributes

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

stateful-session-bean

Stateful session bean component included in the deployment.

*

Stateful session bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

subdeployment

Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.

*

Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.

Attributes

subsystem

Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.

web

Runtime resources exposed by web components in the deployment.

Attributes

expired-sessions

Number of sessions that have expired

rejected-sessions

Number of rejected sessions

max-active-sessions

Max number of concurrent active sessions

session-max-alive-time

The longest time (in seconds) that an expired session had been alive

sessions-created

Total sessions created

session-avg-alive-time

Average time (in seconds) that expired sessions had been alive

context-root

The context root of the web application

virtual-host

The name of the virtual host on which the web application is served

active-sessions

Number of active sessions

duplicated-session-ids

Number of duplicated session IDs generated by the random source (anything bigger than 0 means problems)

servlet

Runtime information about the servlets in the deployment.

*

Runtime information about the servlets in the deployment.

Attributes

min-time

Minimum processing time of a request

load-time

Load time

processingTime

Total execution time of the servlet's service method

maxTime

Maximum processing time of a request

requestCount

Number of requests processed by this servlet

datasources

Runtime resources exposed by data sources included in this deployment.

Attributes

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

data-source

A JDBC data-source configuration

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

messaging

Runtime resources exposed by messaging resources included in this deployment.

Attributes

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

path

webservices

Runtime resources exposed by web service components in the deployment.

Attributes

endpoint

Webservice endpoint.

*

Webservice endpoint.

Attributes

name

Webservice endpoint name.

context

Webservice endpoint context.

class

Webservice endpoint class.

type

Webservice endpoint type.

wsdl-url

Webservice endpoint WSDL URL.

average-processing-time

Average endpoint processing time.

min-processing-time

Minimal endpoint processing time.

max-processing-time

Maximal endpoint processing time.

total-processing-time

Total endpoint processing time.

request-count

Count of requests the endpoint processed.

response-count

Count of responses the endpoint generated.

fault-count

Count of faults the endpoint generated.

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

hibernate-persistence-unit

Persistence unit

*

Runtime information about Hibernate use in the deployment.

Attributes

entity-delete-count

Get number of entity deletes.

entity-insert-count

Get number of entity inserts.

entity-load-count

Get number of entity loads.

entity-fetch-count

Get number of entity fetches.

entity-update-count

Get number of entity updates.

query-execution-count

Get number of executed queries.

query-execution-max-time

Get the time in milliseconds of the slowest query.

query-execution-max-time-query-string

Get the query string for the slowest query.

query-cache-hit-count

Get the number of cached queries successfully retrieved from cache.

query-cache-miss-count

Get the number of cached queries not found in cache.

query-cache-put-count

Get the number of cacheable queries put in cache.

flush-count

Get the number of flushes executed by sessions (either implicit or explicit).

connect-count

Get the number of connections asked for by the sessions.

second-level-cache-hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

second-level-cache-miss-count

Number of cacheable entities/collections not found in the cache and loaded.

second-level-cache-put-count

Number of cacheable entities/collections put in the cache.

session-close-count

Number of sessions closed.

session-open-count

Number of sessions opened.

collection-load-count

Number of collections loaded.

collection-fetch-count

Number of collections fetched.

collection-update-count

Number of collections updated.

collection-remove-count

Number of collections removed.

collection-recreated-count

Number of collections recreated.

successful-transaction-count

Number of successful transactions.

completed-transaction-count

Number of completed transactions.

prepared-statement-count

Number of acquired prepared statements.

close-statement-count

Number of released prepared statements.

optimistic-failure-count

Number of optimistic lock exceptions.

enabled

Determine if statistics are enabled.

Operations

summary

Log the statistics.

Request properties

Returns

Returned type:

clear

Clear statistics.

Request properties

Returns

Returned type:

evict-all

Evict all entities from second level cache.

Request properties

Returns

Returned type:

entity-cache

Statistics for a Hibernate Second Level Cache region.

*

Statistics for a Hibernate Second Level Cache region.

Attributes

miss-count

Number of cacheable entities/collections not found in the cache and loaded.

put-count

Number of cacheable entities/collections put in the cache.

element-count-in-memory

Number of cacheable entities/collections currently stored in memory.

hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

query-cache

Statistics for individual queries.

*

Statistics for individual queries.

Attributes

query-execution-count

Get number of times query has been executed.

query-execution-max-time

Get the time in milliseconds of the query.

query-execution-min-time

Get the minimum time in milliseconds of the query.

query-name

Query name.

query-execution-average-time

Get the average time in milliseconds of the query.

query-cache-miss-count

Get the number of times query was not found in cache.

query-execution-row-count

Get number of rows returned from executions of query.

query-cache-hit-count

Get the number of times query was retrieved from cache.

query-cache-put-count

Get the number of times query was put in cache.

entity

Statistics for individual entities.

*

Statistics for individual entities.

Attributes

entity-load-count

Get number of entity loads.

entity-update-count

Get number of entity updates.

optimistic-failure-count

Number of optimistic lock exceptions.

entity-fetch-count

Get number of entity fetches.

entity-insert-count

Get number of entity inserts.

entity-delete-count

Get number of entity deletes.

collection

Statistics for individual collections.

*

Statistics for individual collections.

Attributes

collection-fetch-count

Number of times collection was fetched.

collection-recreated-count

Number of times collection was recreated.

collection-load-count

Number of times collection was loaded.

collection-update-count

Number of times collection was updated.

collection-remove-count

Number of times collection was removed.

ejb3

Runtime resources exposed by EJBs components included in this deployment.

Attributes

message-driven-bean

Message driven bean component included in the deployment.

*

Message driven bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

singleton-bean

Singleton bean component included in the deployment.

*

Singleton bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

timers

EJB timers associated with the component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

stateless-session-bean

Stateless session bean component included in the deployment.

*

Stateless session bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

entity-bean

Entity bean component included in the deployment.

*

Entity bean component included in the deployment.

Attributes

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

stateful-session-bean

Stateful session bean component included in the deployment.

*

Stateful session bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

subsystem

The subsystems that make up the server's profile.

jaxrs

The configuration of the JAX-RS subsystem.

Attributes

Operations

remove

Operation removing the JAX-RS subsystem.

Request properties

Returns

Returned type:

add

Operation creating the JAX-RS subsystem.

Request properties

Returns

Returned type:

jacorb

The JacORB subsystem configuration.

Attributes

transactions

Indicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts.

support-ssl

Indicates whether SSL is to be supported (on) or not (off).

socket-binding

The name of the socket binding configuration that specifies the ORB port.

pool-size

The size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise.

cache-poa-names

Indicates whether POA names should be cached (on) or not (off).

add-component-via-interceptor

Indicates whether SSL components should be added by an IOR interceptor (on) or not (off).

max-managed-buf-size

The log2 of maximum size managed by the internal buffer manager.

client-timeout

The client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out.

server-supports

Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).

queue-wait

Indicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full.

giop-minor-version

The GIOP minor version to be used.

monitoring

Indicates whether the monitoring GUI should be displayed (on) or not (off).

server-requires

Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).

client-supports

Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).

properties

A list of generic key/value properties.

root-context

The naming service root context.

comet

Indicates whether interoperability with Comet's ORB is enabled (on) or not (off).

ssl-socket-binding

The name of the socket binding configuration that specifies the ORB SSL port.

client-requires

Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).

max-server-connections

The maximum number of connections accepted by the server.

iona

Indicates whether interoperability with IONA's ASP is enabled (on) or not (off).

chunk-custom-rmi-valuetypes

Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off).

queue-max

The maximum number of requests that can be queued.

print-version

Indicates whether the version number should be printed during ORB startup (on) or not (off).

server-timeout

The server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out.

security

Indicates whether the security interceptors are to be installed (on) or not (off).

sun

Indicates whether interoperability with Sun's ORB is enabled (on) or not (off).

lax-boolean-encoding

Indicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off).

strict-check-on-tc-creation

Indicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off).

use-imr

Indicates whether the implementation repository should be used (on) or not (off).

name

The name of the running ORB.

max-threads

The maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job.

use-bom

Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off).

cache-typecodes

Indicates whether typecodes should be cached (on) or not (off).

indirection-encoding-disable

Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off).

queue-min

The size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests.

retry-interval

The interval in milliseconds between retries.

outbuf-cache-timeout

The buffer cache timeout in milliseconds.

outbuf-size

The size of the network buffers for outgoing messages.

security-domain

The name of the security domain that holds the key and trust stores that will be used to establish SSL connections.

retries

The number of retries if connections cannot be promptly established.

export-corbaloc

Indicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off).

Operations

remove

Removes the JacORB subsystem.

Request properties

Returns

Returned type:

add

Adds the JacORB subsystem.

Request properties

Returns

Returned type:

jaxr

The configuration of the JAXR subsystem.

Attributes

jndi-name

The JNDI name under which the JAXR ConnectionFactory is bound

class

The JAXR ConnectionFactory implementation class

Operations

remove

Removes the JAXR subsystem.

Request properties

Returns

Returned type:

add

Adds the JAXR subsystem.

Request properties

Returns

Returned type:

property

A JAXR property. The identity of the resource defines the property name.

*

A JAXR property. The identity of the resource defines the property name.

Attributes

value

The JAXR property value.

Operations

remove

Remove a JAXR property

Request properties

Returns

Returned type:

add

Add a JAXR property

Request properties

Returns

Returned type:

jsf

The JSF (Mojarra) subsystem

Attributes

Operations

remove

Removes the JSF subsystem

Request properties

Returns

Returned type:

add

Adds the JSF subsystem

Request properties

Returns

Returned type:

jmx

The configuration of the JMX subsystem.

Attributes

Operations

remove

Removes the JMX subsystem.

Request properties

Returns

Returned type:

add

Adds the JMX subsystem.

Request properties

Returns

Returned type:

show-model

Expose the model controller in the MBeanServer. The recommended is the 'expression' child.

expression

The configuration for exposing the 'expression' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as String. Reads return the unresolved expression. You may use expressions when writing attributes and setting operation parameters.

Attributes

domain-name

The domain name to use for the 'expression' model controller JMX facade in the MBeanServer.

Operations

remove

Removes the 'expression' model controller JMX facade from the MBeanServer.

Request properties

Returns

Returned type:

add

Adds the 'expression' model controller JMX facade to the MBeanServer.

Request properties

Returns

Returned type:

resolved

The configuration for exposing the 'resolved' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as their type in the underlying model. Reads return the resolved expression if used, or the raw value. You may not use expressions when writing attributes and setting operation parameters.

Attributes

domain-name

The domain name to use for the 'resolved' model controller JMX facade in the MBeanServer.

proper-property-format

If false, PROPERTY type attributes are represented as a DMR string, this is the legacy behaviour. If true, PROPERTY type attributes are represented by a composite type where the key is a string, and the value has the same type as the property in the underlying model.

Operations

remove

Removes the 'resolved' model controller JMX facade from the MBeanServer.

Request properties

Returns

Returned type:

add

Adds the 'resolved' model controller JMX facade to the MBeanServer.

Request properties

Returns

Returned type:

remoting-connector

JBoss remoting connectors for the JMX subsystem.

jmx

A JBoss remoting connector for the JMX subsystem.

Attributes

use-management-endpoint

If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one

Operations

remove

Removes the remote connector for the JMX subsystem.

Request properties

Returns

Returned type:

add

Adds the remote connector for the JMX subsystem.

Request properties

Returns

Returned type:

jca

The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters

Operations

remove

Remove the JCA subsystem

Request properties

Returns

Returned type:

add

Add the JCA subsystem

Request properties

Returns

Returned type:

archive-validation

Archive validation for resource adapters

archive-validation

jca.archive-validation

Attributes

enabled

Specify whether archive validation is enabled

fail-on-error

Should an archive validation error report fail the deployment

fail-on-warn

Should an archive validation warning report fail the deployment

Operations

remove

Remove archive validation functionality

Request properties

Returns

Returned type:

add

Add archive validation functionality

Request properties

Returns

Returned type:

bean-validation

Bean validation (JSR-303) for resource adapters

bean-validation

jca.bean-validation

Attributes

enabled

Specify whether bean validation is enabled

Operations

remove

Remove bean validation functionality

Request properties

Returns

Returned type:

add

Add bean validation functionality

Request properties

Returns

Returned type:

bootstrap-context

Bootstrap context for resource adapters

*

jca.bootstrap-context

Attributes

name

The name of the BootstrapContext

workmanager

The WorkManager instance for the BootstrapContext

Operations

remove

Remove BootstrapContext

Request properties

Returns

Returned type:

add

Add BootstrapContext

Request properties

Returns

Returned type:

workmanager

WorkManager for resource adapters

*

jca.workmanager

Attributes

name

The name of the WorkManager

Operations

remove

Remove work manager

Request properties

Returns

Returned type:

add

Add work manager

Request properties

Returns

Returned type:

long-running-threads

boolean indicating if service for long running activated

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

short-running-threads

boolean indicating if service for short running activated

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

cached-connection-manager

Cached connection manager for resource adapters

cached-connection-manager

jca.cached-connection-manager

Attributes

debug

Enable/disable debug information logging

error

Enable/disable error information logging

install

Enable/disable the cached connection manager valve and interceptor

Operations

remove

Remove cached connection manager functionality

Request properties

Returns

Returned type:

add

Add cached connection manager functionality

Request properties

Returns

Returned type:

threads

The threading subsystem, used to declare manageable thread pools and resources.

Attributes

Operations

remove

Removes the threading subsystem.

Request properties

Returns

Returned type:

add

Adds the threading subsystem.

Request properties

Returns

Returned type:

bounded-queue-thread-pool

A set of thread pools where tasks are stored in a bounded-size queue and where if no space is available in the queue tasks will either be discarded or passed off to another 'handoff-executor' for execution.

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

queueless-thread-pool

A set of thread pools where are not queued and where if no pool thread is available to handle a task the tasks will either be discarded or passed off to another 'handoff-executor' for execution.

*

A thread pool executor with no queue where threads submittings tasks will not block. When a task is submitted, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

current-thread-count

The current number of threads in the pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a queueless thread pool.

Request properties

Returns

Returned type:

unbounded-queue-thread-pool

A set of thread pools where tasks are stored in a queue with no maximum size.

*

A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.

Attributes

active-count

The approximate number of threads that are actively executing tasks.

current-thread-count

The current number of threads in the pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

completed-task-count

The approximate total number of tasks that have completed execution.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been rejected.

Operations

remove

Removes an unbounded thread pool.

Request properties

Returns

Returned type:

add

Adds an unbounded thread pool.

Request properties

Returns

Returned type:

thread-factory

A set of thread factories.

*

A thread factory (implementing java.util.concurrent.ThreadFactory).

Attributes

thread-name-pattern

The template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID.

group-name

Specifies the name of a thread group to create for this thread factory.

priority

May be used to specify the thread priority of created threads.

name

The name of the created thread factory.

Operations

remove

Removes a thread factory

Request properties

Returns

Returned type:

add

Adds a thread factory

Request properties

Returns

Returned type:

blocking-bounded-queue-thread-pool

A set of thread pools where tasks are stored in a bounded-size queue and where threads submitting tasks will block until space is available in the queue.

*

A thread pool executor with a bounded queue where threads submittings tasks may block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the caller blocks until room becomes available in the queue.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a blocking bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a blocking bounded queue thread pool.

Request properties

Returns

Returned type:

blocking-queueless-thread-pool

A set of thread pools where are not queued and where threads submitting tasks will block until a pool thread is available to execute the task.

*

A thread pool executor with no queue where threads submittings tasks may block. When a task is submitted, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the caller blocks until another thread completes its task and accepts the new one.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

current-thread-count

The current number of threads in the pool.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a blocking queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a blocking queueless thread pool.

Request properties

Returns

Returned type:

scheduled-thread-pool

A set of scheduled thread pools.

*

A scheduled thread pool executor.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

active-count

The approximate number of threads that are actively executing tasks.

completed-task-count

The approximate total number of tasks that have completed execution.

current-thread-count

The current number of threads in the pool.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a queueless thread pool.

Request properties

Returns

Returned type:

webservices

The configuration of the web services subsystem.

Attributes

modify-wsdl-address

Whether the soap address can be modified.

wsdl-host

The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the

wsdl-port

The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

wsdl-secure-port

The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

Operations

remove

Removes the web services subsystem.

Request properties

Returns

Returned type:

add

Adds the web services subsystem.

Request properties

Returns

Returned type:

endpoint-config

Webservice endpoint configuration

*

Webservice endpoint configuration

Operations

remove

Remove endpoint configuration

Request properties

Returns

Returned type:

add

Add endpoint configuration

Request properties

Returns

Returned type:

pre-handler-chain

Endpoint configuration PRE handler chain

*

Endpoint configuration PRE handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Endpoint configuration PRE handler chain

Request properties

Returns

Returned type:

add

Endpoint configuration PRE handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

post-handler-chain

Endpoint configuration POST handler chain

*

Endpoint configuration POST handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Endpoint configuration POST handler chain

Request properties

Returns

Returned type:

add

Endpoint configuration POST handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

property

Endpoint configuration property

*

Endpoint configuration property

Attributes

value

Endpoint configuration property value

Operations

remove

Remove endpoint configuration property

Request properties

Returns

Returned type:

add

Add endpoint configuration property

Request properties

Returns

Returned type:

client-config

Webservice client configuration

*

Webservice client configuration

Operations

remove

Remove client configuration

Request properties

Returns

Returned type:

add

Add client configuration

Request properties

Returns

Returned type:

pre-handler-chain

Client configuration PRE handler chain

*

Client configuration PRE handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Client configuration PRE handler chain

Request properties

Returns

Returned type:

add

Client configuration PRE handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

post-handler-chain

Client configuration POST handler chain

*

Client configuration POST handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Client configuration POST handler chain

Request properties

Returns

Returned type:

add

Client configuration POST handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

property

Client configuration property

*

Client configuration property

Attributes

value

Client configuration property value

Operations

remove

Remove client configuration property

Request properties

Returns

Returned type:

add

Add client configuration property

Request properties

Returns

Returned type:

sar

The SAR subsystem allowing you to deploy sar archives containing MBeans configured by META-INF/jboss-service.xml

Attributes

Operations

remove

Removes the SAR subsystem

Request properties

Returns

Returned type:

add

Adds the SAR subsystem

Request properties

Returns

Returned type:

configadmin

The ConfigAdmin subsystem configuration.

Operations

remove

Remove the ConfigAdmin subsystem configuration.

Request properties

Returns

Returned type:

add

Add the ConfigAdmin subsystem configuration.

Request properties

Returns

Returned type:

configuration

A Configuration Admin Service entry. The identity of the resource defines the Configuration Admin PID (Persistent Identifier) that entries are associated with.

*

A Configuration Admin Service entry. The identity of the resource defines the Configuration Admin PID (Persistent Identifier) that entries are associated with.

Attributes

entries

The list of configuration entries.

Operations

update

Update a configuration entry.

Request properties

Returns

Returned type:

remove

Remove a configuration entry.

Request properties

Returns

Returned type:

add

Add a configuration entry.

Request properties

Returns

Returned type:

remoting

The configuration of the Remoting subsystem.

Attributes

worker-read-threads

The number of read threads to create for the remoting worker.

worker-task-max-threads

The maximum number of threads for the remoting worker task thread pool.

worker-task-limit

The maximum number of remoting worker tasks to allow before rejecting.

worker-task-core-threads

The number of core threads for the remoting worker task thread pool.

worker-write-threads

The number of write threads to create for the remoting worker.

worker-task-keepalive

The number of milliseconds to keep non-core remoting worker task threads alive.

Operations

remove

Removes the Remoting subsystem.

Request properties

Returns

Returned type:

add

Adds the Remoting subsystem.

Request properties

Returns

Returned type:

outbound-connection

Remoting outbound connections.

*

Remoting outbound connection.

Attributes

uri

The connection URI for the outbound connection.

Operations

remove

Removes a generic URI based remoting outbound connection.

Request properties

Returns

Returned type:

add

Adds a generic URI based remoting outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

remote-outbound-connection

Remoting outbound connections for remote:// URI scheme.

*

Remoting outbound connection with a implicit remote:// URI scheme.

Attributes

outbound-socket-binding-ref

Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.

username

The user name to use when authenticating against the remote server.

security-realm

Reference to the security realm to use to obtain the password and SSL configuration.

Operations

remove

Removes a remote:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

add

Adds a remote:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

connector

The remoting connectors.

*

The configuration of a Remoting connector.

Attributes

authentication-provider

The "authentication-provider" element contains the name of the authentication provider to use for incoming connections.

socket-binding

The name (or names) of the socket binding(s) to attach to.

security-realm

The associated security realm to use for authentication for this connector.

Operations

remove

Removes a remoting connector.

Request properties

Returns

Returned type:

add

Adds a Remoting connector.

Request properties

Returns

Returned type:

security

Configuration of security for this connector.

sasl

The "sasl" element contains the SASL authentication configuration for this connector.

Attributes

qop

The optional nested "qop" element contains a list of quality-of-protection values, in decreasing order of preference.

include-mechanisms

The optional nested "include-mechanisms" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.

strength

The optional nested "strength" element contains a list of cipher strength values, in decreasing order of preference.

server-auth

The optional nested "server-auth" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.

reuse-session

The optional nested "reuse-session" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.

Operations

remove

Removes the SASL authentication configuration for its connector

Request properties

Returns

Returned type:

add

Adds the SASL authentication configuration for its connector

Request properties

Returns

Returned type:

sasl-policy

Specifies an optional policy to use to narrow down the available set of mechanisms.

policy

The policy configuration.

Attributes

forward-secrecy

The optional nested "forward-secrecy" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.

no-plain-text

The optional nested "no-plain-text" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted. "false" to permit, "true" to deny.

no-active

The optional nested "no-active" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. "false" to permit, "true" to deny.

pass-credentials

The optional nested "pass-credentials" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.

no-dictionary

The optional nested "no-dictionary" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. "false" to permit, "true" to deny.

no-anonymous

The optional nested "no-anonymous" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. "false" to permit, "true" to deny.

Operations

remove

Removes the SASL policy.

Request properties

Returns

Returned type:

add

Adds the SASL policy.

Request properties

Returns

Returned type:

property

Properties to further configure sasl.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

property

Properties to further configure the connector.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

local-outbound-connection

Remoting outbound connections for local:// URI scheme.

*

Remoting outbound connection with a implicit local:// URI scheme.

Attributes

outbound-socket-binding-ref

Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.

Operations

remove

Removes a local:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

add

Adds a local:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

infinispan

The configuration of the infinispan subsystem

Operations

remove

Remove the infinispan subsystem

Request properties

Returns

Returned type:

add

Add the infinispan subsystem

Request properties

Returns

Returned type:

cache-container

The configuration of an infinispan cache container

*

The configuration of an infinispan cache container

Attributes

default-cache

The default infinispan cache

aliases

The list of aliases for this cache container

jndi-name

The jndi name to which to bind this cache container

start

The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

listener-executor

The executor used for the replication queue

eviction-executor

The scheduled executor used for eviction

replication-queue-executor

The executor used for asynchronous cache operations

module

The module whose class loader should be used when building this cache container's configuration.

Operations

remove-alias

Remove an alias for this cache container

Request properties

Returns

Returned type:

remove

Remove a cache container from the infinispan subsystem

Request properties

Returns

Returned type:

add-alias

Add an alias for this cache container

Request properties

Returns

Returned type:

add

Add a cache container to the infinispan subsystem

Request properties

Returns

Returned type:

transport

The description of the transport used by this cache container

TRANSPORT

The description of the transport used by this cache container

Attributes

stack

The jgroups stack to use for the transport

cluster

The name of the group communication cluster

executor

The executor to use for the transport

lock-timeout

The timeout for locks for the transport

Operations

remove

Remove the transport from the cache container

Request properties

Returns

Returned type:

add

Add the transport to the cache container

Request properties

Returns

Returned type:

local-cache

A local cache

*

A local cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a local cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

invalidation-cache

An invalidation cache

*

An invalidation cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add an invalidation cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

replicated-cache

A replicated cache

*

A replicated cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a replicated cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

state-transfer

The state transfer configuration for distribution and replicated caches.

STATE_TRANSFER

The state transfer configuration for distribution and replicated caches.

Attributes

enabled

If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.

timeout

The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.

chunk-size

The size, in bytes, in which to batch the transfer of cache entries.

Operations

remove

Remove a state transfer configuration.

Request properties

Returns

Returned type:

add

Add a state transfer configuration.

Request properties

Returns

Returned type:

distributed-cache

A distributed cache

*

A distributed cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

owners

Number of cluster-wide replicas for each cache entry.

virtual-nodes

Controls the number of virtual nodes per "real" node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used.

l1-lifespan

Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a distributed cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

state-transfer

The state transfer configuration for distribution and replicated caches.

STATE_TRANSFER

The state transfer configuration for distribution and replicated caches.

Attributes

enabled

If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.

timeout

The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.

chunk-size

The size, in bytes, in which to batch the transfer of cache entries.

Operations

remove

Remove a state transfer configuration.

Request properties

Returns

Returned type:

add

Add a state transfer configuration.

Request properties

Returns

Returned type:

weld

The configuration of the weld subsystem.

Attributes

Operations

remove

Operation removing the weld subsystem.

Request properties

Returns

Returned type:

add

Operation creating the weld subsystem.

Request properties

Returns

Returned type:

osgi

The OSGi subsystem configuration

Attributes

activation

Activation flag for the OSGi subsystem. Possible values: lazy, eager

startlevel

The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly

Operations

activate

Activate the OSGi subsystem

Request properties

Returns

Returned type:

remove

Remove the OSGi subsystem configuration

Request properties

Returns

Returned type:

add

Add the OSGi subsystem configuration

Request properties

Returns

Returned type:

property

A framework property. The identity of the resource defines the property name

*

A framework property. The identity of the resource defines the property name

Attributes

value

The framework property value

Operations

remove

Remove a framework property

Request properties

Returns

Returned type:

add

Add a framework property

Request properties

Returns

Returned type:

capability

A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle

*

A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle

Attributes

startlevel

The startlevel for the capability. Can only be specified for OSGi bundles

Operations

remove

Remove a framework capability

Request properties

Returns

Returned type:

add

Add a framework capability

Request properties

Returns

Returned type:

bundle

Runtime bundle information. The resource can be identified by bundle id or bundle location

*

Runtime bundle information. The resource can be identified by bundle id or bundle location

Attributes

id

The bundle ID

startlevel

The bundle's start level

symbolic-name

The bundle symbolic name

version

The bundle version

state

State of bundle

type

Type of Bundle

location

The bundle location

Operations

stop

Stops a bundle

Request properties

Returns

Returned type:

start

Starts a bundle

Request properties

Returns

Returned type:

ejb3

The configuration of the ejb3 subsystem.

Attributes

default-mdb-instance-pool

Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level

default-entity-bean-optimistic-locking

If set to true entity beans will use optimistic locking by default

in-vm-remote-interface-invocation-pass-by-value

If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value.

default-clustered-sfsb-cache

Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level

default-entity-bean-instance-pool

Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level

default-distinct-name

The default distinct name that is applied to every EJB deployed on this server

default-singleton-bean-access-timeout

The default access timeout for singleton beans

default-sfsb-cache

Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level

default-resource-adapter-name

Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level

enable-statistics

If set to true, enable the collection of invocation statistics.

default-stateful-bean-access-timeout

The default access timeout for stateful beans

default-slsb-instance-pool

Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level

Operations

remove

Removes the ejb3 subsystem.

Request properties

Returns

Returned type:

add

Adds the ejb3 subsystem.

Request properties

Returns

Returned type:

service

Centrally configurable services that are part of the EJB3 subsystem.

async

The EJB3 Asynchronous Invocation Service

Attributes

thread-pool-name

The name of the thread pool which handles asynchronous invocations

Operations

remove

Removes the EJB3 Asynchronous Invocation Service

Request properties

Returns

Returned type:

add

Adds the EJB3 Asynchronous Invocation Service

Request properties

Returns

Returned type:

iiop

The IIOP service

Attributes

enable-by-default

If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor

use-qualified-name

If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)

Operations

remove

Removes IIOP support

Request properties

Returns

Returned type:

add

Adds IIOP support to the EJB3 subsystem

Request properties

Returns

Returned type:

remote

The EJB3 Remote Service

Attributes

thread-pool-name

The name of the thread pool that handles remote invocations

connector-ref

The name of the connector on which the EJB3 remoting channel is registered

Operations

remove

Removes the EJB3 remote service

Request properties

Returns

Returned type:

add

Adds the EJB3 remote service

Request properties

Returns

Returned type:

channel-creation-options

The options that will be used during the EJB remote channel creation

*

The options that will be used during the EJB remote channel creation

Attributes

value

The value for the EJB remote channel creation option

type

The type of the channel creation option

Operations

remove

Removes a EJB remote channel creation option

Request properties

Returns

Returned type:

add

Adds a EJB remote channel creation option

Request properties

Returns

Returned type:

timer-service

The EJB timer service

Attributes

path

The directory to store persistent timer information in

thread-pool-name

The name of the thread pool used to run timer service invocations

relative-to

The relative path that is used to resolve the timer data store location

Operations

remove

Removes the timer service

Request properties

Returns

Returned type:

add

Adds the timer service

Request properties

Returns

Returned type:

thread-pool

An EJB thread pool

*

A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.

Attributes

active-count

The approximate number of threads that are actively executing tasks.

current-thread-count

The current number of threads in the pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

completed-task-count

The approximate total number of tasks that have completed execution.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been rejected.

Operations

remove

Removes an unbounded thread pool.

Request properties

Returns

Returned type:

add

Adds an unbounded thread pool.

Request properties

Returns

Returned type:

file-passivation-store

A file system based passivation store

*

A file system based passivation store

Attributes

idle-timeout

The timeout in units specified by idle-timeout-unit, after which a bean will passivate

groups-path

sessions-path

relative-to

subdirectory-count

max-size

The maximum number of beans this cache should store before forcing old beans to passivate

idle-timeout-unit

The unit of idle-timeout

Operations

remove

Removes a file system based passivation store

Request properties

Returns

Returned type:

add

Adds a file system based passivation store

Request properties

Returns

Returned type:

strict-max-bean-instance-pool

A bean instance pool with a strict upper limit

*

A bean instance pool with a strict upper limit

Attributes

timeout-unit

The instance acquisition timeout unit

max-pool-size

The maximum number of bean instances that the pool can hold at a given point in time

timeout

The maximum amount of time to wait for a bean instance to be available from the pool

Operations

remove

Removes a specific a bean instance pool which has a strict upper limit for bean instances

Request properties

Returns

Returned type:

add

Adds a bean instance pool which has a strict upper limit for bean instances

Request properties

Returns

Returned type:

cache

A SFSB cache

*

A SFSB cache

Attributes

aliases

The aliases by which this cache may also be referenced

passivation-store

The passivation store used by this cache

Operations

remove

Removes a cache

Request properties

Returns

Returned type:

add

Adds a cache

Request properties

Returns

Returned type:

cluster-passivation-store

A clustered passivation store

*

A clustered passivation store

Attributes

idle-timeout

The timeout in units specified by idle-timeout-unit, after which a bean will passivate

cache-container

The name of the cache container used for the bean and client-mappings caches

client-mappings-cache

The name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings

bean-cache

The name of the cache used to store bean instances.

passivate-events-on-replicate

Indicates whether replication should trigger passivation events on the bean

max-size

The maximum number of beans this cache should store before forcing old beans to passivate

idle-timeout-unit

The unit of idle-timeout

Operations

remove

Removes a clustered passivation store

Request properties

Returns

Returned type:

add

Adds a clustered passivation store

Request properties

Returns

Returned type:

transactions

The configuration of the transaction subsystem.

Attributes

relative-to

References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.

process-id-uuid

Indicates whether the transaction manager should use a UUID based process id.

number-of-nested-transactions

The total number of nested (sub) transactions created.

socket-binding

Used to reference the correct socket binding to use for the recovery environment.

number-of-timed-out-transactions

The number of transactions that have rolled back due to timeout.

jts

If true this enables the Java Transaction Service

number-of-transactions

The total number of transactions (top-level and nested) created

object-store-path

Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.

path

Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.

number-of-committed-transactions

The number of committed transactions.

number-of-heuristics

The number of transactions which have terminated with heuristic outcomes.

process-id-socket-binding

The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.

default-timeout

The default timeout.

number-of-aborted-transactions

The number of aborted (i.e. rolledback) transactions.

process-id-socket-max-ports

The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.

use-hornetq-store

Use the HornetQ journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log. The server should be restarted for this setting to take effect.

number-of-inflight-transactions

The number of transactions that have begun but not yet terminated.

recovery-listener

Used to specify if the recovery system should listen on a network socket or not.

number-of-application-rollbacks

The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behavior is considered an attribute of the application configuration.

status-socket-binding

Used to reference the correct socket binding to use for the transaction status manager.

node-identifier

Used to set the node identifier on the core environment.

enable-tsm-status

Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not..

object-store-relative-to

References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.

enable-statistics

Whether statistics should be enabled.

number-of-resource-rollbacks

The number of transactions that rolled back due to resource (participant) failure.

Operations

remove

Removes the transaction subsystem

Request properties

Returns

Returned type:

add

Adds the transaction subsystem

Request properties

Returns

Returned type:

log-store

Representation of the transaction logging storage mechanism.

log-store

Representation of the transaction logging storage mechanism.

Attributes

type

Specifies the implementation type of the logging store.

Operations

remove

Remove a representation of the transaction logging storage mechanism.

Request properties

Returns

Returned type:

add

Add a representation of the transaction logging storage mechanism.

Request properties

Returns

Returned type:

probe

Scan for new transaction logs. This operation will creates a child for each pending transaction.

Request properties

Returns

Returned type:

transactions

The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.

*

The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.

Attributes

id

The id of this transaction.

jmx-name

The JMX name of this transaction.

type

The type name under which this record is stored.

age-in-seconds

The time since this transaction was prepared or when the recovery system last tried to recover it.

Operations

delete

Remove this transaction log. WARNING after this operation the transaction manager will have no knowledge of the transaction and will therefore never be able to recover it. If you are sure that the transaction is complete then the operation is safe. The representation of the transaction log is removed from the model too.

Request properties

Returns

Returned type:

participants

The resources that did work in a transaction.

*

The resources that did work in a transaction.

Attributes

jmx-name

The JMX name of this participant.

eis-product-name

The JCA enterprise information system's product name.

status

Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).

eis-product-version

The JCA enterprise information system's product version

jndi-name

JNDI name of this participant.

type

The type name under which this record is stored.

Operations

refresh

Refresh the management view of the attributes of this participant record by querying the transaction log. (Note that the read-resource operaton only reads the model, hence the need for this refresh operation).

Request properties

Returns

Returned type:

recover

If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction.

Request properties

Returns

Returned type:

datasources

The data-sources subsystem, used to declare JDBC data-sources

Attributes

installed-drivers

List of JDBC drivers that have been installed in the runtime

Operations

installed-drivers-list

List of JDBC drivers that have been installed in the runtime

Request properties

Returns Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

Returned type: LIST

remove

Removes the data-sources subsystem

Request properties

Returns

Returned type:

get-installed-driver

Get a description of an installed driver

Request properties

Returns Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

Returned type: OBJECT

add

Adds the data-sources subsystem

Request properties

Returns

Returned type:

jdbc-driver

Service that make a JDBC driver available for use in the runtime

*

A service that makes a JDBC driver available for use in the runtime

Attributes

driver-name

The symbolic name of this driver used to reference it in the registry

deployment-name

The name of the deployment unit from which the driver was loaded

driver-module-name

The name of the module from which the driver was loaded, if it was loaded from the module path

module-slot

The slot of the module from which the driver was loaded, if it was loaded from the module path

driver-class-name

The fully qualified class name of the java.sql.Driver implementation

xa-datasource-class

The fully qualified class name of the javax.sql.XADataSource implementation

driver-major-version

The driver's major version number

driver-minor-version

The driver's minor version number

jdbc-compliant

Whether or not the driver is JDBC compliant

Operations

remove

Remove a JDBC driver

Request properties

Returns

Returned type:

add

Add a new JDBC driver

Request properties

Returns

Returned type:

data-source

A JDBC data-source configuration

ExampleDS

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

statistics

Runtime statistics provided by the resource adapter.

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the data-source

Request properties

Returns

Returned type:

enable

Enable the data-source

Request properties

Returns

Returned type:

disable

Disable the data-source

Request properties

Returns

Returned type:

add

Add a new data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

Operations

remove

Remove the connection property

Request properties

Returns

Returned type:

add

Add a connection property

Request properties

Returns

Returned type:

statistics

jdbc

Runtime statistics provided by the resource adapter.

Attributes

PreparedStatementCacheCurrentSize

The number of prepared and callable statements currently cached in the statement cache

PreparedStatementCacheMissCount

The number of times that a statement request could not be satisfied with a statement from the cache

PreparedStatementCacheAddCount

The number of statements added to the statement cache

PreparedStatementCacheAccessCount

The number of times that the statement cache was accessed

PreparedStatementCacheDeleteCount

The number of statements discarded from the cache

PreparedStatementCacheHitCount

The number of times that statements from the cache were used

Operations

clear-statistics

Clear statistics values for this resource

Request properties

Returns

Returned type:

pool

Runtime statistics provided by the resource adapter.

Attributes

AverageBlockingTime

The average time spent blocking for a connection

TimedOut

The timed out count

MaxWaitTime

The maximum wait time for a connection

ActiveCount

The active count

CreatedCount

The created count

TotalBlockingTime

The total blocking time

AverageCreationTime

The average time spent creating a physical connection

MaxCreationTime

The maximum time for creating a physical connection

TotalCreationTime

The total time spent creating physical connections

AvailableCount

The available count

MaxUsedCount

The maximum number of connections used

DestroyedCount

The destroyed count

Operations

clear-statistics

Clear statistics values for this resource

Request properties

Returns

Returned type:

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the data-source

Request properties

Returns

Returned type:

enable

Enable the data-source

Request properties

Returns

Returned type:

disable

Disable the data-source

Request properties

Returns

Returned type:

add

Add a new data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

Operations

remove

Remove the connection property

Request properties

Returns

Returned type:

add

Add a connection property

Request properties

Returns

Returned type:

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the XA data-source

Request properties

Returns

Returned type:

enable

Enable the XA data-source

Request properties

Returns

Returned type:

disable

Disable the XA data-source

Request properties

Returns

Returned type:

add

Add a new XA data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

Operations

remove

Remove the xa-datasource-property

Request properties

Returns

Returned type:

add

Add a single xa-datasource-property

Request properties

Returns

Returned type:

deployment-scanner

An individual deployment scanner that scans a particular location

Attributes

Operations

remove

Remove the deployment scanner subsystem.

Request properties

Returns

Returned type:

add

Add the deployment scanner subsystem.

Request properties

Returns

Returned type:

scanner

The scanners maintained by the subsystem.

*

The configuration of the deployment scanner subsystem

Attributes

relative-to

Reference to a filesystem path defined in the "paths" section of the server configuration.

path

The actual filesystem path to be scanned. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

auto-deploy-exploded

Allows the automatic deployment of exploded content without requiring a .dodeploy marker file. Recommended for only basic development scenarios to prevent exploded application deployment from occuring during changes by the developer or operating system.

auto-deploy-xml

Allows automatic deployment of XML content without requiring a .dodeploy marker file.

scan-enabled

Flag indicating that all scanning (including initial scanning at startup) should be disabled.

scan-interval

Periodic interval, in milliseconds, at which the repository should be scanned for changes. A value of less than 1 indicates the repository should only be scanned at initial startup.

auto-deploy-zipped

Allows automatic deployment of zipped content without requiring a .dodeploy marker file.

deployment-timeout

The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.

Operations

remove

Remove a deployment scanner

Request properties

Returns

Returned type:

add

Add a new deployment scanner

Request properties

Returns

Returned type:

logging

The configuration of the logging subsystem.

Operations

remove

Remove the logging subsystem.

Request properties

Returns

Returned type:

add

Add the logging subsystem.

Request properties

Returns

Returned type:

root-logger

Defines the root logger for this log context.

ROOT

Defines the root logger for this log context.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

handlers

The Handlers associated with this Logger.

Operations

remove-root-logger

Remove the root logger.

Request properties

Returns

Returned type:

remove

Remove the root logger.

Request properties

Returns

Returned type:

root-logger-unassign-handler

Unassign a Handler from the root logger.

Request properties

Returns

Returned type:

change-root-log-level

Change the root logger level.

Request properties

Returns

Returned type:

set-root-logger

Set the root logger.

Request properties

Returns

Returned type:

root-logger-assign-handler

Assign a Handler to the root logger.

Request properties

Returns

Returned type:

add

Set the root logger.

Request properties

Returns

Returned type:

logger

Defines a logger category.

*

Defines a logger category.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

handlers

The Handlers associated with this Logger.

use-parent-handlers

Specifies whether or not this logger should send its output to it's parent Logger.

Operations

assign-handler

Assign a Handler to a Logger.

Request properties

Returns

Returned type:

remove

Remove an existing logger category.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a logger category.

Request properties

Returns

Returned type:

add

Add a new logger category.

Request properties

Returns

Returned type:

unassign-handler

Unassign a Handler from a Logger.

Request properties

Returns

Returned type:

async-handler

Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.

*

Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

queue-length

The queue length to use before flushing writing

overflow-action

Specify what action to take when the overflowing. The valid options are 'block' and 'discard'

subhandlers

The Handlers associated with this async handler.

encoding

The character encoding used by this Handler.

Operations

unassign-subhandler

Unassign a subhandler from the ASYNC handler.

Request properties

Returns

Returned type:

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing ASYNC handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

assign-subhandler

Assign a subhandler to the ASYNC handler.

Request properties

Returns

Returned type:

add

Add a new ASYNC handler.

Request properties

Returns

Returned type:

console-handler

Defines a handler which writes to the console.

*

Defines a handler which writes to the console.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

target

Defines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing console handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to the console.

Request properties

Returns

Returned type:

file-handler

Defines a handler which writes to a file.

*

Defines a handler which writes to a file.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to a file.

Request properties

Returns

Returned type:

periodic-rotating-file-handler

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

*

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

suffix

Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing periodic rotating file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Request properties

Returns

Returned type:

size-rotating-file-handler

Defines a handler which writes to a file, rotating the log after a the size of the file grows beyond a certain point and keeping a fixed number of backups.

*

Defines a handler which writes to a file, rotating the log after a the size of the file grows beyond a certain point and keeping a fixed number of backups.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

rotate-size

The size at which to rotate the log file.

max-backup-index

The maximum number of backups to keep.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing size rotating file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Add a new size rotating file handler.

Request properties

Returns

Returned type:

custom-handler

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

*

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

class

The logging handler class to be used.

module

The module that the logging handler depends on.

properties

Defines the properties used for the logging handler. All properties must be accessible via a setter method.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing custom logging handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

Request properties

Returns

Returned type:

jdr

JBoss Diagnostic Reporter (JDR) Subsystem.

Operations

remove

Removes the JDR subsystem.

Request properties

Returns

Returned type:

generate-jdr-report

Request the generation of a JDR report.

Request properties

Returns jdr.report.return

Returned type: OBJECT

add

Adds the JDR subsystem.

Request properties

Returns

Returned type:

messaging

The messaging subsystem.

Attributes

Operations

remove

Operation removing the messaging subsystem

Request properties

Returns

Returned type:

add

Operation adding the messaging subsystem

Request properties

Returns

Returned type:

jms-bridge

A JMS bridge instance.

*

A JMS bridge instance.

Attributes

selector

A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.

failure-retry-interval

The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.

source-destination

The name of the source destination to lookup on the source messaging server.

quality-of-service

The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).

target-password

The password for creating the target connection.

max-batch-size

The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.

max-retries

The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.

client-id

The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.

source-password

The password for creating the source connection.

target-connection-factory

The name of the target connection factory to lookup on the target messaging server.

target-destination

The name of the target destination to lookup on the target messaging server.

module

The name of AS7 module containing the resources required to lookup source and target JMS resources.

source-context

he properties used to configure the source JNDI initial context.

paused

Whether the JMS bridge is paused.

source-connection-factory

The name of the source connection factory to lookup on the source messaging server.

add-messageID-in-header

If true, then the original message's message ID will be appended in the message sent to the destination in the header HORNETQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.

source-user

The name of the user for creating the source connection.

target-user

The name of the user for creating the target connection.

subscription-name

The name of the subscription if it is durable and the source destination is a topic.

max-batch-time

The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.

started

Whether the JMS bridge is started.

target-context

The properties used to configure the target JNDI initial context.

Operations

pause

Pause the JMS bridge.

Request properties

Returns

Returned type:

stop

Stop the JMS bridge.

Request properties

Returns

Returned type:

resume

Resume the JMS bridge.

Request properties

Returns

Returned type:

remove

Remove an existing JMS bridge.

Request properties

Returns

Returned type:

start

Start the JMS bridge.

Request properties

Returns

Returned type:

add

Add a new JMS bridge.

Request properties

Returns

Returned type:

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

in-vm-acceptor

Defines a way in which in-VM connections can be made to the HornetQ server.

*

Defines a way in which in-VM connections can be made to the HornetQ server.

Attributes

server-id

The server id.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

remove

Remove a JMS queue.

Request properties

Returns

Returned type:

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

add-jndi

Adds the queue to another JNDI binding

Request properties

Returns

Returned type:

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

add

Add a JMS queue.

Request properties

Returns

Returned type:

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

security-setting

A security setting allows sets of permissions to be defined against queues based on their address.

*

A security setting allows sets of permissions to be defined against queues based on their address.

Operations

remove

Remove an existing security setting.

Request properties

Returns

Returned type:

add

Add new security setting.

Request properties

Returns

Returned type:

role

A security role.

*

A security role.

Attributes

send

This permission allows the user to send a message to matching addresses.

consume

his permission allows the user to consume a message from a queue bound to matching addresses.

create-durable-queue

This permission allows the user to create a durable queue.

delete-durable-queue

This permission allows the user to delete a durable queue.

create-non-durable-queue

This permission allows the user to create a temporary queue.

delete-non-durable-queue

This permission allows the user to delete a temporary queue.

manage

This permission allows the user to invoke management operations by sending management messages to the management address.

Operations

remove

Remove an existing security role.

Request properties

Returns

Returned type:

add

Add new security role.

Request properties

Returns

Returned type:

address-setting

An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.

*

An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.

Attributes

address-full-policy

Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK)

dead-letter-address

The dead letter address

last-value-queue

Defines whether a queue only uses last values or not

max-delivery-attempts

Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address

max-size-bytes

The max bytes size.

message-counter-history-day-limit

Day limit for the message counter history.

expiry-address

Defines where to send a message that has expired.

redelivery-delay

Defines how long to wait before attempting redelivery of a cancelled message

redistribution-delay

Defines how long to wait when the last consumer is closed on a queue before redistributing any messages

page-max-cache-size

The number of page files to keep in memory to optimize IO during paging navigation.

page-size-bytes

The paging size.

send-to-dla-on-no-route

If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists.

Operations

remove

Operation removing an existing address-setting

Request properties

Returns

Returned type:

add

Operation adding an address-setting

Request properties

Returns

Returned type:

grouping-handler

Makes decisions about which node in a cluster should handle a message with a group id assigned.

*

Makes decisions about which node in a cluster should handle a message with a group id assigned.

Attributes

type

Whether the handler is the single "Local" handler for the cluster, which makes handling decisions, or a "Remote" handler which converses with the local handler.

grouping-handler-address

A reference to a cluster connection and the address it uses.

timeout

How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept.

Operations

remove

Operation removing the grouping handler.

Request properties

Returns

Returned type:

add

Operation adding the grouping handler. Only one grouping handler is allowed.

Request properties

Returns

Returned type:

acceptor

An acceptor defines a way in which connections can be made to the HornetQ server.

*

An acceptor defines a way in which connections can be made to the HornetQ server.

Attributes

factory-class

The factory class.

socket-binding

The socket binding reference.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

remove

Remove a JMS topic.

Request properties

Returns

Returned type:

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

add-jndi

Adds the queue to another JNDI binding

Request properties

Returns

Returned type:

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

add

Add a JMS topic.

Request properties

Returns

Returned type:

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

in-vm-connector

Used by an in-VM client to define how it connects to a server.

*

Used by an in-VM client to define how it connects to a server.

Attributes

server-id

The server id.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

divert

A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.

*

A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.

Attributes

divert-address

Address to divert from

exclusive

Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all.

routing-name

Routing name of the divert

forwarding-address

Address to divert to

filter

An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.

transformer-class-name

The name of a class used to transform the message's body or properties before it is diverted.

Operations

remove

Operation removing a divert

Request properties

Returns

Returned type:

add

Operation adding a divert

Request properties

Returns

Returned type:

queue

A Queue.

*

A Queue.

Attributes

queue-address

The queue address defines what address is used for routing messages.

filter

A queue message filter definition. An undefined or empty filter will match all messages.

durable

Defines whether the queue is durable.

id

The id of the queue.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

remove

Operation removing an existing queue.

Request properties

Returns

Returned type:

list-scheduled-messages-as-json

List the messages scheduled for delivery as a string in JSON format.

Request properties

Returns A string in JSON format representing a list where each element is a map of message properties to their value.

Returned type: STRING

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

add

Operation adding a core queue.

Request properties

Returns

Returned type:

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

list-scheduled-messages

List the messages scheduled for delivery.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

resume

Resume the queue.

Request properties

Returns

Returned type:

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

core-address

A runtime-only resource representing a HornetQ "address". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.

*

A runtime-only resource representing a HornetQ "address". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.

Attributes

roles

A list of the security roles (name and permissions) associated with the address.

queue-names

The names of the queues associated with the address.

number-of-bytes-per-page

The number of bytes used by each page for this address.

number-of-pages

The number of pages used by this address.

binding-names

The names of all bindings (both queues and diverts) bound to this address.

Operations

get-roles-as-json

Returns the roles (name and permissions) associated to this address using JSON serialization.

Request properties

Returns A string JSON format.

Returned type: STRING

pooled-connection-factory

Defines a managed connection factory.

*

Defines a managed connection factory.

Attributes

connector

Defines the connectors. These are stored in a map by connector name (with an undefined value).

entries

The jndi names the connection factory should be bound to.

auto-group

The autogroup.

block-on-acknowledge

True to set block on acknowledge.

block-on-durable-send

True to set block on durable send.

block-on-non-durable-send

True to set block on non durable send.

cache-large-message-client

True to cache large messages.

call-timeout

The call time out.

client-failure-check-period

The client failure check period.

client-id

The client id.

confirmation-window-size

The confirmation window size.

connection-ttl

The connection ttl.

consumer-max-rate

The consumer max rate.

consumer-window-size

The consumer window size.

discovery-group-name

The discovery group name.

discovery-initial-wait-timeout

The discovery initial wait time out.

dups-ok-batch-size

The dups ok batch size.

failover-on-initial-connection

True to fail over on initial connection.

failover-on-server-shutdown

True to fail over on server shutdown.

group-id

The group id.

ha

Whether the connection factory supports High Availability.

connection-load-balancing-policy-class-name

Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.

max-retry-interval

The max retry interval.

min-large-message-size

The min large message size.

password

The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

pre-acknowledge

True to pre-acknowledge.

producer-max-rate

The producer max rate.

producer-window-size

The producer window size.

reconnect-attempts

The reconnect attempts.

retry-interval

The retry interval.

retry-interval-multiplier

The retry interval multiplier.

scheduled-thread-pool-max-size

The scheduled thread pool max size.

thread-pool-max-size

The thread pool max size.

transaction-batch-size

The transaction batch size.

use-auto-recovery

True to use auto recovery.

use-global-pools

True to use global pools.

use-jndi

Use JNDI to locate the destination for incoming connections

user

The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

jndi-params

The JNDI params to use for locating the destination for incoming connections.

use-local-tx

Use a local transaction for incoming sessions

setup-attempts

The number of times to set up an MDB endpoint

setup-interval

The interval between attempts at setting up an MDB endpoint.

transaction

TODO

min-pool-size

The minimum size for the pool

max-pool-size

The maximum size for the pool

Operations

remove

Removes managed a connection factory.

Request properties

Returns

Returned type:

add

Adds a managed connection factory.

Request properties

Returns

Returned type:

connector

A connector can be used by a client to define how it connects to a server.

*

A connector can be used by a client to define how it connects to a server.

Attributes

factory-class

The factory class.

socket-binding

The socket binding reference.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

remote-acceptor

Defines a way in which remote connections can be made to the HornetQ server.

*

Defines a way in which remote connections can be made to the HornetQ server.

Attributes

socket-binding

The socket binding reference.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

remote-connector

Used by a remote client to define how it connects to a server.

*

Used by a remote client to define how it connects to a server.

Attributes

socket-binding

The socket binding reference.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

cluster-connection

Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.

*

Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.

Attributes

cluster-connection-address

Each cluster connection only applies to messages sent to an address that starts with this value.

connector-ref

The confirmation-window-size to use for the connection used to forward messages to a target node.

min-large-message-size

The minimum size (in bytes) for a message before it is considered as a large message.

connection-ttl

The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).

retry-interval

The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.

retry-interval-multiplier

A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.

max-retry-interval

The maximum interval of time used to retry connections

reconnect-attempts

The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.

use-duplicate-detection

Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

check-period

The period (in milliseconds) between client failure check.

call-timeout

The timeout (in ms) for remote calls made by the cluster connection.

forward-when-no-consumers

Whether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then HornetQ will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message.

max-hops

The maximum number of times a message can be forwarded. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ servers as intermediates in a chain.

confirmation-window-size

The confirmation-window-size to use for the connection used to forward messages to a target node.

static-connectors

The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.

discovery-group-name

The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.

allow-direct-connections-only

Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.

node-id

The node ID used by this cluster connection.

topology

The topology of the nodes that this cluster connection is aware of.

started

Whether the cluster connection is started.

Operations

stop

Stops the cluster connection.

Request properties

Returns

Returned type:

get-nodes

Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.

Request properties

Returns A map where keys are node IDs and values are the addresses used to connect to the nodes.

Returned type: OBJECT

remove

Operation removing a cluster connection

Request properties

Returns

Returned type:

start

Starts the cluster connection.

Request properties

Returns

Returned type:

get-static-connectors-as-json

Returns the list of static connectors as a string in JSON format.

Request properties

Returns

Returned type: STRING

add

Operation adding a cluster connection

Request properties

Returns

Returned type:

connection-factory

Defines a connection factory.

*

Defines a connection factory.

Attributes

connector

Defines the connectors. These are stored in a map by connector name (with an undefined value).

entries

The jndi names the connection factory should be bound to.

auto-group

Whether or not message grouping is automatically used

block-on-acknowledge

True to set block on acknowledge.

block-on-durable-send

True to set block on durable send.

block-on-non-durable-send

True to set block on non durable send.

cache-large-message-client

True to cache large messages.

call-timeout

The call time out.

client-failure-check-period

The client failure check period.

client-id

The client id.

compress-large-messages

Whether large messages should be compressed.

confirmation-window-size

The confirmation window size.

connection-ttl

The connection ttl.

consumer-max-rate

The consumer max rate.

consumer-window-size

The consumer window size.

discovery-group-name

The discovery group name.

discovery-initial-wait-timeout

The discovery initial wait time out.

dups-ok-batch-size

The dups ok batch size.

failover-on-initial-connection

True to fail over on initial connection.

failover-on-server-shutdown

True to fail over on server shutdown.

group-id

The group id.

ha

Whether the connection factory supports High Availability.

connection-load-balancing-policy-class-name

Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.

max-retry-interval

The max retry interval.

min-large-message-size

The min large message size.

pre-acknowledge

True to pre-acknowledge.

producer-max-rate

The producer max rate.

producer-window-size

The producer window size.

reconnect-attempts

The reconnect attempts.

retry-interval

The retry interval.

retry-interval-multiplier

The retry interval multiplier.

scheduled-thread-pool-max-size

The scheduled thread pool max size.

thread-pool-max-size

The thread pool max size.

transaction-batch-size

The transaction batch size.

use-global-pools

True to use global pools.

factory-type

The type of connection factory.

initial-message-packet-size

The initial size of messages created through this factory.

Operations

remove

Removes a connection factory.

Request properties

Returns

Returned type:

add-jndi

Adds the factory to another JNDI binding

Request properties

Returns

Returned type:

add

Adds a connection factory.

Request properties

Returns

Returned type:

broadcast-group

A broadcast group is the means by which a server broadcasts connectors over the network.

*

A broadcast group is the means by which a server broadcasts connectors over the network.

Attributes

connectors

Specifies the names of connectors that will be broadcast.

group-address

The multicast address to which the data will be broadcast. It is a class D IP address in the range 224.0.0.0 to 239.255.255.255, inclusive. The address 224.0.0.0 is reserved and is not available for use.

group-port

The UDP port number used for broadcasting.

local-bind-address

The local bind address that the datagram socket is bound to. If you have multiple network interfaces on your server, you would specify which one you wish to use for broadcasts by setting this attribute. If this attribute is not specified then the socket will be bound to the wildcard address, an IP address chosen by the kernel.

started

Whether the broadcast group is started.

local-bind-port

The local port to which the datagram socket is bound. Normally you would just use the default value of -1 which signifies that an anonymous port should be used. This parameter is always specified in conjunction with local-bind-address.

socket-binding

The broadcast group socket binding.

broadcast-period

The period in milliseconds between consecutive broadcasts.

Operations

get-connector-pairs-as-json

Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.

Request properties

Returns

Returned type:

stop

Stops the broadcast group.

Request properties

Returns

Returned type:

remove

Remove a broadcast group.

Request properties

Returns

Returned type:

start

Starts the broadcast group.

Request properties

Returns

Returned type:

add

Add a broadcast group.

Request properties

Returns

Returned type:

path

A filesystem path pointing to one of the locations where HornetQ stores persistent data.

journal-directory

The directory in which the message journal lives. The default is ${jboss.server.data.dir}/messaging/journal.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

paging-directory

The directory where page files are stored. The default is ${jboss.server.data.dir}/messaging/paging.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

large-messages-directory

The directory in which large messages are stored. The default is ${jboss.server.data.dir}/messaging/largemessages.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

bindings-directory

The directory in which the bindings journal lives. The default is ${jboss.server.data.dir}/messaging/bindings.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

bridge

The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different HornetQ server.

*

The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different HornetQ server.

Attributes

min-large-message-size

The minimum size (in bytes) for a message before it is considered as a large message.

check-period

The period (in milliseconds) between client failure check.

failover-on-server-shutdown

Deprecated. Has no runtime effect and a warning will be issued if an attempt is made to set the value of this attribute.

retry-interval-multiplier

A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.

forwarding-address

The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.

transformer-class-name

The name of a user-defined class which implements the org.hornetq.core.server.cluster.Transformer interface.

ha

Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.

reconnect-attempts

The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.

password

The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used.

static-connectors

A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.

retry-interval

The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.

discovery-group-name

The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.

queue-name

The unique name of the local queue that the bridge consumes from.

use-duplicate-detection

Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

max-retry-interval

The maximum interval of time used to retry connections

started

Whether the bridge is started.

confirmation-window-size

The confirmation-window-size to use for the connection used to forward messages to the target node.

user

The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used.

filter

An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.

connection-ttl

The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).

Operations

stop

Stops the bridge.

Request properties

Returns

Returned type:

remove

Operation removing a bridge.

Request properties

Returns

Returned type:

start

Starts the bridge.

Request properties

Returns

Returned type:

add

Operation adding a bridge.

Request properties

Returns

Returned type:

discovery-group

Multicast group to listen to receive broadcast from other servers announcing their connectors.

*

Multicast group to listen to receive broadcast from other servers announcing their connectors.

Attributes

refresh-timeout

Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.

group-address

Multicast IP address of the group to listen on.

group-port

UDP port of the multicast group.

local-bind-address

The local bind address that the datagram socket is bound to.

socket-binding

The discovery group socket binding.

initial-wait-timeout

Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.

Operations

remove

Remove a discovery group.

Request properties

Returns

Returned type:

add

Add a discovery group.

Request properties

Returns

Returned type:

connector-service

TODO

*

TODO

Attributes

factory-class

Class name of the factory class that can instantiate the connector service.

Operations

remove

Operation removing a connector service

Request properties

Returns

Returned type:

add

Operation adding a connector service

Request properties

Returns

Returned type:

param

A key/value pair understood by the connector service's factory-class

*

A key/value pair understood by the connector service's factory-class

Attributes

value

Value portion of a key/value pair understood by the connector service's factory-class

Operations

remove

Removes a key/value pair understood by the connector service's factory-class

Request properties

Returns

Returned type:

add

Adds a key/value pair understood by the connector service's factory-class

Request properties

Returns

Returned type:

pojo

Support JBoss5 and JBoss6 pojo configuration model.

Attributes

Operations

remove

Remove pojo subsystem

Request properties

Returns

Returned type:

add

Add pojo subsystem

Request properties

Returns

Returned type:

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

naming

The configuration of the naming subsystem.

Attributes

Operations

remove

Removes the naming subsystem.

Request properties

Returns

Returned type:

jndi-view

Dump the local JNDI tree

Request properties

Returns

Returned type:

add

Adds the naming subsystem.

Request properties

Returns

Returned type:

binding

JNDI bindings for primitive types

*

JNDI bindings for primitive types

Attributes

module

The module to load the object factory from for object factory bindings

environment

The environment to use on object factory instance retrieval

binding-type

The type of binding to create, may be simple, lookup or object-factory

value

The value to bind for simple bindings

class

The object factory class name for object factory bindings

type

The type of the value to bind for simple bindings, this must be a primitive type

lookup

The entry to lookup in JNDI for lookup bindings

Operations

remove

Removes a JNDI binding

Request properties

Returns

Returned type:

add

Adds a JNDI binding

Request properties

Returns

Returned type:

service

Naming based services

remote-naming

The remote naming server

Attributes

Operations

remove

Removes the remote naming server

Request properties

Returns

Returned type:

add

Adds the remote naming server

Request properties

Returns

Returned type:

ee

The configuration of the EE subsystem.

Attributes

global-modules

A list of modules that should be made available to all deployments.

spec-descriptor-property-replacement

Flag indicating whether descriptors defined by the Java EE specification will have property replacements applied

jboss-descriptor-property-replacement

Flag indicating whether JBoss specific deployment descriptors will have property replacements applied

ear-subdeployments-isolated

Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.

Operations

remove

Removes the EE subsystem.

Request properties

Returns

Returned type:

add

Adds the EE subsystem.

Request properties

Returns

Returned type:

mail

The mail subsystem

Attributes

Operations

remove

Removes the mail subsystem

Request properties

Returns

Returned type:

add

Adds the mail subsystem

Request properties

Returns

Returned type:

mail-session

Mail session definition

*

Mail session definition

Attributes

jndi-name

JNDI name to where mail session should be bound

debug

Enables JavaMail debugging

from

From address that is used as default from, if not set when sending

Operations

remove

Adds a mail session

Request properties

Returns

Returned type:

add

Adds a mail session

Request properties

Returns

Returned type:

server

Mail session server

pop3

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

imap

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

smtp

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

web

The configuration of the jboss.web subsystem.

Attributes

default-virtual-server

The web container's default virtual server.

instance-id

Set the identifier for this server instance.

native

Add the native initialization listener to the web container.

Operations

remove

Operation removing the web subsystem.

Request properties

Returns

Returned type:

add

Operation adding the web subsystem.

Request properties

Returns

Returned type:

configuration

The common web container configuration.

container

Common container configuration

Attributes

mime-mapping

A mime-mapping definition.

welcome-file

A welcome files declaration.

Operations

add-mime

Adds mime type

Request properties

Returns

Returned type:

remove

Removes web container

Request properties

Returns

Returned type:

remove-mime

Remove mime type

Request properties

Returns

Returned type:

add

Adds web container

Request properties

Returns

Returned type:

static-resources

Static files serving configuration.

Attributes

sendfile

Enable sendfile if possible, for files bigger than the specified byte size.

max-depth

Maximum recursion for PROPFIND.

read-only

Allow write HTTP methods (PUT, DELETE).

webdav

Enable WebDAV functionality.

secret

Secret for WebDAV locking operations.

file-encoding

Force a file encoding.

listings

Enable folder listings.

disabled

Disables the default Servlet mapping.

Operations

remove

Remove static configuration

Request properties

Returns

Returned type:

add

Add static configuration

Request properties

Returns

Returned type:

jsp-configuration

JSP container configuration.

Attributes

trim-spaces

Trim some spaces from the generated Servlet.

source-vm

Source VM level for compilation.

development

Enable the development mode, which gives more information when an error occurs.

keep-generated

Keep the generated Servlets.

recompile-on-fail

Retry failed JSP compilations on each request.

check-interval

Check interval for JSP updates using a background thread.

modification-test-interval

Minimum amount of time between two tests for updates, in seconds.

scratch-dir

Specify a different work directory.

display-source-fragment

When a runtime error occurs, attempts to display corresponding JSP source fragment.

error-on-use-bean-invalid-class-attribute

Enable errors when using a bad class in useBean.

java-encoding

Specify the encoding used for Java sources.

tag-pooling

Enable tag pooling.

generate-strings-as-char-arrays

Generate String constants as char arrays.

target-vm

Target VM level for compilation.

x-powered-by

Enable advertising the JSP engine in x-powered-by.

dump-smap

Write SMAP data to a file.

mapped-file

Map to the JSP source.

disabled

Enable the JSP container.

smap

Enable SMAP.

Operations

remove

Removes JSP container configuration.

Request properties

Returns

Returned type:

add

Adds JSP container configuration.

Request properties

Returns

Returned type:

virtual-server

A virtual host.

*

A virtual host.

Attributes

enable-welcome-root

Whether or not the bundled welcome directory is used as the root web context.

default-web-module

The web module deployment name that will be mapped as the root webapp.

alias

The virtual server aliases

name

A unique virtual host name

Operations

remove

Remove an existing virtual-server

Request properties

Returns

Returned type:

add

Add a new virtual-server

Request properties

Returns

Returned type:

configuration

configuration of virutal server

sso

The SSO configuration for this virtual server.

Attributes

domain

The cookie domain that will be used.

cache-container

Enables clustered SSO using the specified clustered cache container.

reauthenticate

Enables reauthentication with the realm when using SSO.

cache-name

Name of the cache to use in the cache container.

Operations

remove

Erase the SSO configuration from the virtual server.

Request properties

Returns

Returned type:

add

Add a SSO configuration for this virtual server.

Request properties

Returns

Returned type:

access-log

The access log configuration for this virtual server.

Attributes

pattern

The access log pattern.

rotate

Rotate the access log every day.

prefix

Prefix for the log file name.

extended

Enable extended pattern, with more options.

resolve-hosts

Host resolution.

Operations

remove

Remove access log configuration from this virtual server.

Request properties

Returns

Returned type:

add

Add access log configuration to this virtual server.

Request properties

Returns

Returned type:

directory

The location for the access logging.

setting

Settings for access log

directory

The location for the access logging.

Attributes

path

The relative folder path.

relative-to

The folder the path is relative to.

Operations

remove

Removes directory

Request properties

Returns

Returned type:

add

Adds directory

Request properties

Returns

Returned type:

rewrite

A list of rewrite rules that will be processed in order on the URL or vhost specified in the request.

*

A list of rewrite rules that will be processed in order on the URL or vhost specified in the request.

Attributes

substitution

The string that will replace the original URL or vhost.

flags

Option flags for this rewrite rule.

pattern

The pattern that will be matched.

Operations

remove

Remove a rule from the list of rewrite rules.

Request properties

Returns

Returned type:

add

Add a rule to the list of rewrite rules.

Request properties

Returns

Returned type:

condition

A list of conditions this rule needs to match for rewrite to occur.

*

A list of conditions this rule needs to match for rewrite to occur.

Attributes

flags

Option flags for this condition.

pattern

The pattern to match.

test

Test pattern for the condition.

Operations

remove

Remove a condition from the list of conditions of the rule.

Request properties

Returns

Returned type:

add

Add a condition to the list of conditions of the rule.

Request properties

Returns

Returned type:

sso

The SSO configuration for this virtual server.

access-log

The access log configuration for this virtual server.

connector

A web connector.

*

A web connector.

Attributes

bytesSent

Number of byte sent by the connector.

proxy-port

The port that will be used when sending a redirect.

secure

Indicates if content sent or received by the connector is secured from the user perspective.

virtual-server

The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers.

errorCount

Number of error that occurs when processing requests by the connector.

maxTime

Max time spent to process a requests.

socket-binding

The web connector socket-binding reference, this connector should be bound to.

scheme

The web connector scheme.

name

A unique name for the connector.

max-post-size

Maximum size in bytes of a POST request that can be parsed by the container.

requestCount

Number of the request processed by the connector.

proxy-name

The host name that will be used when sending a redirect. The default value is null.

enabled

Defines whether the connector should be started on startup.

protocol

The web connector protocol.

enable-lookups

Enable DNS lookups for Servlet API.

executor

The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool.

processingTime

Processing time used by the connector. Im milli-seconds.

redirect-port

The port for redirection to a secure connector.

bytesReceived

Number of byte received by the connector (POST data).

max-connections

Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used.

max-save-post-size

Maximum size in bytes of a POST request that will be saved during certain authentication schemes.

Operations

remove

Remove an existing web connector

Request properties

Returns

Returned type:

add

Add a new web connector.

Request properties

Returns

Returned type:

ssl

The SSL configuration of the connector.

configuration

Various additional configuration

ssl

The SSL configuration of the connector.

Attributes

key-alias

The key alias.

verify-depth

Limit certificate nesting.

protocol

The SSL protocols that are enabled.

cipher-suite

The allowed cipher suite.

certificate-file

Server certificate file.

ca-certificate-password

Certificate password.

ca-certificate-file

Certificate authority.

session-cache-size

SSL session cache.

password

Password.

session-timeout

SSL session cache timeout.

ca-revocation-url

Certificate authority revocation list.

truststore-type

Type of the truststore, There are various types of keystores available, including "PKCS12" and Sun's "JKS."

name

The configuration name.

certificate-key-file

Key file for the certificate.

verify-client

Enable client certificate verification.

keystore-type

Type of the keystore, There are various types of keystores available, including "PKCS12" and Sun's "JKS."

Operations

remove

Remove the SSL configuration of the connector.

Request properties

Returns

Returned type:

add

Add an SSL configuration of the connector.

Request properties

Returns

Returned type:

cmp

The configuration of the cmp subsystem.

Attributes

Operations

remove

Removes the cmp subsystem.

Request properties

Returns

Returned type:

add

Adds the cmp subsystem.

Request properties

Returns

Returned type:

uuid-keygenerator

UUID based key generators

*

UUID based key generators

Attributes

Operations

remove

Remove a UUID key generator

Request properties

Returns

Returned type:

add

Add a UUID key generator

Request properties

Returns

Returned type:

hilo-keygenerator

HiLo based key generators

*

HiLo based key generators

Attributes

block-size

The block size

sequence-name

The name of the sequence

sequence-column

The sequence column name

create-table

Boolean to determine whether to create create the tables

data-source

The datasource used for sequence generation

select-hi-ddl

The DDL used to select the hi value

drop-table

Boolean to determine whether to create drop the tables

create-table-ddl

The DDL used to create the table

id-column

The ID column name

table-name

The table name

Operations

remove

Remove a HiLo key generator

Request properties

Returns

Returned type:

add

Add a HiLo key generator

Request properties

Returns

Returned type:

jsr77

The configuration of the JSR-77 subsystem.

Attributes

Operations

remove

Removes the jSR-77 subsystem.

Request properties

Returns

Returned type:

add

Adds the JSR-77 subsystem.

Request properties

Returns

Returned type:

resource-adapters

Configuration of the resource adapters subsystem

Operations

remove

Removes the resource adapters subsystem

Request properties

Returns

Returned type:

add

Adds the resource adapters subsystem

Request properties

Returns

Returned type:

resource-adapter

The configuration of a resource adapter

*

resource-adapter

Attributes

archive

Specifies the resource adapter archive

transaction-support

Specifies the transaction support level of the resource adapter

bootstrap-context

Specifies the unique name of the bootstrap context that should be used

config-properties

Custom defined config properties

beanvalidationgroups

Specifies the bean validation groups that should be used

Operations

activate

Force the resource adapter config activation without server reload

Request properties

Returns

Returned type:

remove

Remove the resource adapter

Request properties

Returns

Returned type:

add

Add a new resource adapter

Request properties

Returns

Returned type:

connection-definitions

Specifies the connection definitions

*

connection-definitions

Attributes

class-name

Specifies the fully qualified class name of a managed connection factory or admin object

jndi-name

Specifies the JNDI name for the connection factory or admin object

use-java-context

Setting this to false will bind the object into global JNDI

enabled

Specifies if the resource adapter should be enabled

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

security-domain-and-application

Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool

security-application

Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

use-ccm

Enable the use of a cached connection manager

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-username

The user name used for recovery

no-recovery

Specifies if the connection pool should be excluded from recovery

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

pad-xid

Should the Xid be padded

pool-prefill

Should the pool be prefilled. Changing this value requires a server restart

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the connection definition

Request properties

Returns

Returned type:

add

Add a connection definition

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

admin-objects

Specifies the administration objects

*

admin-objects

Attributes

class-name

Specifies the fully qualified class name of a managed connection factory or admin object

jndi-name

Specifies the JNDI name for the connection factory or admin object

use-java-context

Setting this to false will bind the object into global JNDI

enabled

Specifies if the resource adapter should be enabled

Operations

remove

Remove the administration object

Request properties

Returns

Returned type:

add

Add an administration object

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

security

The configuration of the security subsystem.

Attributes

deep-copy-subject-mode

Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads.

Operations

remove

Removes the security subsystem.

Request properties

Returns

Returned type:

add

Adds the security subsystem.

Request properties

Returns

Returned type:

security-domain

Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.

*

Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.

Attributes

cache-type

Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.

Operations

remove

Remove a security domain.

Request properties

Returns

Returned type:

list-cached-principals

Lists the principals stored in the authentication cache for this security domain.

Request properties

Returns list-cached-principals.return

Returned type: LIST

add

Add a security domain.

Request properties

Returns

Returned type:

flush-cache

Remove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.

Request properties

Returns

Returned type:

identity-trust

Identity trust configuration. Configures a list of trust modules to be used.

classic

Identity trust configuration. Configures a list of trust modules to be used.

Attributes

trust-modules

List of trust modules

Operations

remove

Removes an identity trust configuration.

Request properties

Returns

Returned type:

add

Adds an identity trust configuration.

Request properties

Returns

Returned type:

authentication

"Authentication configuration for this domain. Can either be classic or jaspi.

classic

Traditional authentication configuration. Configures a list of login modules to be used.

Attributes

login-modules

List of authentication modules

Operations

remove

Removes a traditional authentication configuration

Request properties

Returns

Returned type:

add

Adds a traditional authentication configuration

Request properties

Returns

Returned type:

jaspi

JASPI authentication configuration.

Attributes

auth-modules

List of authentication modules to be used.

Operations

remove

Removes a JASPI authentication configuration

Request properties

Returns

Returned type:

add

Adds a JASPI authentication configuration

Request properties

Returns

Returned type:

login-module-stack

List of "named" login modules that are used by jaspi authentication modules.

*

List of "named" login modules that are used by jaspi authentication modules.

Attributes

login-modules

List of authentication modules

Operations

remove

Removes a named login module stack configuration

Request properties

Returns

Returned type:

add

Adds a named login module stack configuration

Request properties

Returns

Returned type:

acl

Access control list configuration. Configures a list of ACL modules to be used.

classic

Access control list configuration. Configures a list of ACL modules to be used.

Attributes

acl-modules

List of acl modules

Operations

remove

Removes an ACL configuration

Request properties

Returns

Returned type:

add

Adds an ACL configuration

Request properties

Returns

Returned type:

audit

Auditing configuration. Configures a list of provider modules to be used.

classic

Auditing configuration. Configures a list of provider modules to be used.

Attributes

provider-modules

List of provider modules

Operations

remove

Removes and audit configuration

Request properties

Returns

Returned type:

add

Adds an audit configuration

Request properties

Returns

Returned type:

mapping

Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.

classic

Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.

Attributes

mapping-modules

List of modules that map principal, role, and credential information

Operations

remove

Removes a mapping configuration.

Request properties

Returns

Returned type:

add

Adds a mapping configuration.

Request properties

Returns

Returned type:

jsse

JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.

classic

JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.

Attributes

client-auth

Boolean attribute to indicate if client's certificates should also be authenticated on the server side.

protocols

Comma separated list of protocols to enable on SSLSockets.

truststore

Configures a JSSE trust store

trust-manager

JSEE Trust Manager factory

key-manager

JSEE Key Manager factory

service-auth-token

Token to retrieve PrivateKeys from the KeyStore.

keystore

Configures a JSSE key store

additional-properties

Additional properties that may be necessary to configure JSSE.

server-alias

Preferred alias to use when the KeyManager chooses the server alias.

client-alias

Preferred alias to use when the KeyManager chooses the client alias.

cipher-suites

Comma separated list of cipher suites to enable on SSLSockets.

Operations

remove

Removes a JSSE configuration.

Request properties

Returns

Returned type:

add

Adds a JSSE configuration

Request properties

Returns

Returned type:

authorization

Authorization configuration. Configures a list of authorization policy modules to be used.

classic

Authorization configuration. Configures a list of authorization policy modules to be used.

Attributes

policy-modules

List of authorization modules

Operations

remove

Removes an authorization configuration

Request properties

Returns

Returned type:

add

Adds an authorization configuration

Request properties

Returns

Returned type:

vault

Security Vault for attributes.

classic

Security Vault for attributes.

Attributes

vault-options

Security Vault options.

code

Fully Qualified Name of the Security Vault Implementation.

Operations

remove

Removes a security vault configuration

Request properties

Returns

Returned type:

add

Adds a security vault configuration

Request properties

Returns

Returned type:

extension

A list of extension modules.

*

A module that extends the standard capabilities of a domain or a standalone server.

Attributes

module

The name of the module.

Operations

remove

Removes an extension.

Request properties

Returns

Returned type:

add

Adds an extension.

Request properties

Returns

Returned type:

subsystem

A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.

*

A subsystem provided by the extension. What is provided here is information about the xml schema and management interface provided by the subsystem, not the configuration of the subsystem itself.

Attributes

management-major-version

Major version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

management-micro-version

Micro version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

xml-namespaces

A list of URIs for the XML namespaces supported by the subsystem's XML parser. May be empty if the extension did not clearly associate an XML namespace with a particular subsystem.

management-minor-version

Minor version of the subsystem's management interface. May be undefined if the subsystem does not currently provide a versioned management interface.

path

A list of named filesystem paths.

*

A named filesystem path.

Attributes

name

The name of the path. Cannot be one of the standard fixed paths provided by the system:

Note that the system provides other standard paths that can be overridden by declaring them in the configuration file. See the 'relative-to' attribute documentation for a complete list of standard paths.

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

read-only

True if added by the system, false if configured by user. If true, the path cannot be removed or modified.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path

Request properties

Returns

Returned type:

add

Add a new path.

Request properties

Returns

Returned type:

system-property

A list of system properties to set on the server.

*

A system property to set on the server.

Attributes

value

The value of the system property.

Operations

remove

Removes a system property.

Request properties

Returns

Returned type:

add

Adds a system property or updates an existing one.

Request properties

Returns

Returned type:

core-service

Core services provided by the server.

service-container

The central container that manages all services in a running standalone server or in a host controller in a management domain.

Operations

dump-services

Dumps all services running in the container, including their status and dependency information.

Request properties

Returns

Returned type: STRING

vault

Security Vault for attributes.

Attributes

code

Fully Qualified Name of the Security Vault Implementation.

vault-options

Security Vault options.

Operations

remove

Remove the Security Vault.

Request properties

Returns

Returned type:

add

Add the Security Vault.

Request properties

Returns

Returned type:

server-environment

The server environment.

Attributes

config-file

The configuration file used to launch JBoss Application Server.

initial-running-mode

The current running mode of the server. Either LIVE (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests.

ext-dirs

A list of ext directories.

content-dir

The directory where user content (e.g. deployments) that is managed by the server is stored.

log-dir

The directory where log files are sent.

temp-dir

The temporary directory.

data-dir

The data directory.

node-name

The name of the server node.

deploy-dir

Deprecated variant of 'content-dir'.

base-dir

The base directory for JBoss Application Server.

home-dir

The home directory for JBoss Application Server.

host-name

The host name.

launch-type

The type of the running server.

modules-dir

The directory where modules are found.

qualified-host-name

The qualified host name.

config-dir

The directory where the configurations are stored.

server-name

The name of the server.

platform-mbean

Provides the management interface for monitoring and management of the Java virtual machine as well as the operating system on which the Java virtual machine is running. Exposes the JDK-provided JMX MBeans in the java.lang, java.nio and java.util.logging JMX domains.

Attributes

Operations

type

The platform MBeans, organized by the value of the 'type' property in the MBean's ObjectName.

compilation

The management interface for the compilation system of the Java virtual machine

Attributes

name

The name of the Just-in-time (JIT) compiler.

compilation-time-monitoring-supported

Whether the Java virtual machine supports the monitoring of compilation time.

total-compilation-time

The approximate accumulated elapsed time (in milliseconds) spent in compilation. A Java virtual machine implementation may not support compilation time monitoring. If "compilation-time-monitoring-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

object-name

String representation the object name of this platform managed object.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

memory-manager

Parent resource for the resources providing the management interface for the Java virtual machine's memory managers.

Attributes

Operations

name

The MemoryManagerMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a memory manager. A memory manager manages one or more memory pools of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing this memory manager.

valid

Whether this memory manager is valid in the Java virtual machine.

memory-pool-names

The names of the memory pools that this memory manager manages.

Operations

garbage-collector

Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.

Attributes

Operations

name

The GarbageCollectorMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for one of the garbage collectors in the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing this garbage collector.

valid

Whether this this memory manager is valid in the Java virtual machine.

memory-pool-names

The name of memory pools that this garbage collector manages.

collection-count

The total number of collections that have occurred.

collection-time

The approximate accumulated collection elapsed time in milliseconds.

Operations

memory

The management interface for the memory system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

verbose

Whether verbose output for the memory system is enabled.

object-pending-finalization-count

The approximate number of objects for which finalization is pending.

heap-memory-usage

The current memory usage of the heap that is used for object allocation.

non-heap-memory-usage

The current memory usage of non-heap memory that is used by the Java virtual machine.

Operations

gc

Runs the garbage collector.

Request properties

Returns

Returned type:

threading

The management interface for the thread system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

thread-contention-monitoring-enabled

Whether thread contention monitoring is enabled.

thread-cpu-time-enabled

Whether thread CPU time measurement is enabled.

all-thread-ids

All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

thread-contention-monitoring-supported

Whether the Java virtual machine supports thread contention monitoring.

thread-cpu-time-supported

Whether the Java virtual machine implementation supports CPU time measurement for any thread.

current-thread-cpu-time-supported

Whether the Java virtual machine supports CPU time measurement for the current thread.

object-monitor-usage-supported

Whether the Java virtual machine supports monitoring of object monitor usage.

synchronizer-usage-supported

Whether the Java virtual machine supports monitoring of ownable synchronizer usage.

thread-count

The current number of live threads including both daemon and non-daemon threads.

peak-thread-count

The peak live thread count since the Java virtual machine started or peak was reset.

total-started-thread-count

The total number of threads created and also started since the Java virtual machine started.

daemon-thread-count

The current number of live daemon threads.

current-thread-cpu-time

The total CPU time for the current thread in nanoseconds, or -1 if "thread-cpu-time-enabled" is "false". A Java virtual machine implementation may not support CPU time measurement. If "thread-cpu-time-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

current-thread-user-time

The CPU time that the current thread has executed in user mode in nanoseconds, or -1 if "thread-cpu-time-enabled" is "false". A Java virtual machine implementation may not support CPU time measurement. If "thread-cpu-time-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

Operations

get-thread-infos

Returns the thread info for each thread whose ID is in the input list.

Request properties

Returns A list of detyped representations of java.lang.management.ThreadInfo objects, each containing information about a thread whose ID is in the corresponding element of the input list of IDs. An element will be "undefined" if the thread of the given ID is not alive or it does not exist.

Returned type: LIST

get-thread-cpu-time

Returns the total CPU time for a thread of the specified ID in nanoseconds.

Request properties

Returns

Returned type: LONG

find-monitor-deadlocked-threads

Finds cycles of threads that are in deadlock waiting to acquire object monitors.

Request properties

Returns A list of thread ids of deadlocked threads, if any, or "undefined" otherwise.

Returned type: LIST

reset-peak-thread-count

Resets the peak thread count to the current number of live threads.

Request properties

Returns

Returned type:

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

dump-all-threads

Returns the thread info for all live threads with stack trace and synchronization information.

Request properties

Returns A list of detyped representations of java.lang.management.ThreadInfo objects.

Returned type: LIST

get-thread-user-time

Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.

Request properties

Returns

Returned type: LONG

find-deadlocked-threads

Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.

Request properties

Returns A list of thread ids of deadlocked threads, if any, or "undefined" otherwise.

Returned type: LIST

get-thread-info

Returns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.

Request properties

Returns Detyped representation of a java.lang.management.ThreadInfo object for the thread of the given ID; "undefined" if the thread of the given ID is not alive or it does not exist.

Returned type: OBJECT

operating-system

The management interface for the operating system on which the Java virtual machine is running.

Attributes

object-name

String representation the object name of this platform managed object.

name

The operating system name. If a security manager is installed and it does not allow access to system property "os.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

arch

The operating system architecture. If a security manager is installed and it does not allow access to system property "os.arch", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

version

The operating system version. If a security manager is installed and it does not allow access to system property "os.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

available-processors

The number of processors available to the Java virtual machine.

system-load-average

The system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

buffer-pool

Parent resource for the resources providing the management interface for the Java virtual machine's buffer pools.

Attributes

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

Operations

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a buffer pool, for example a pool of direct or mapped buffers.

Attributes

name

The BufferPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

count

An estimate of the number of buffers in the pool.

memory-used

An estimate of the memory that the Java virtual machine is using for this buffer pool in bytes, or -1 if an estimate of the memory usage is not available.

total-capacity

An estimate of the total capacity of the buffers in this pool. A buffer's capacity is the number of elements it contains and the value of this attribute is an estimate of the total capacity of buffers in the pool in bytes.

object-name

String representation the object name of this platform managed object.

Operations

memory-pool

Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.

Attributes

Operations

name

The MemoryPoolMXBean platform MBeans, organized by the value of the 'name' property in the MBean's ObjectName.

*

The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.

Attributes

object-name

String representation the object name of this platform managed object.

usage-threshold

The usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold

The collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

name

The name representing this memory pool.

type

The type of this memory pool.

valid

Whether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.

memory-manager-names

The names of the memory managers that manage this memory pool.

usage-threshold-supported

Whether this memory pool supports usage threshold.

collection-usage-threshold-supported

Whether this memory pool supports a collection usage threshold.

usage

An estimate of the memory usage of this memory pool. May be "undefined" if attribute "valid" is "false".

peak-usage

The peak memory usage of this memory pool since the Java virtual machine was started or since the peak was reset. May be "undefined" if attribute "valid" is "false".

usage-threshold-exceeded

Whether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

usage-threshold-count

The number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If "usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold-exceeded

Whether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage-threshold-count

The number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If "collection-usage-threshold-supported", is "false" trying to read this attribute via the "read-attribute" operation will result in failure, and the value of this attribute in the result of a "read-resource" operation will be "undefined".

collection-usage

The memory usage after the Java virtual machine most recently expended effort in recycling unused objects in this memory pool, or "undefined" if this attribute is not supported.

Operations

reset-peak-usage

Resets the peak memory usage statistic of this memory pool to the current memory usage.

Request properties

Returns

Returned type:

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

runtime

The management interface for the runtime system of the Java virtual machine.

Attributes

object-name

String representation the object name of this platform managed object.

name

The name representing the running Java virtual machine.

vm-name

The Java virtual machine implementation name. If a security manager is installed and it does not allow access to system property "java.vm.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

vm-vendor

The Java virtual machine implementation vendor. If a security manager is installed and it does not allow access to system property "java.vm.vendor", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

vm-version

The Java virtual machine implementation version. If a security manager is installed and it does not allow access to system property "java.vm.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-name

The Java virtual machine specification name. If a security manager is installed and it does not allow access to system property "java.vm.specification.name", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-vendor

The Java virtual machine specification vendor. If a security manager is installed and it does not allow access to system property "java.vm.specification.vendor", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

spec-version

The Java virtual machine specification version. If a security manager is installed and it does not allow access to system property "java.vm.specification.version", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

management-spec-version

The version of the specification for the management interface implemented by the running Java virtual machine.

class-path

The Java class path that is used by the system class loader to search for class files. If a security manager is installed and it does not allow access to system property "java.class.path", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

library-path

The Java library path. If a security manager is installed and it does not allow access to system property "java.library.path", then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

boot-class-path-supported

Whether the Java virtual machine supports the boot class path mechanism used by the bootstrap class loader to search for class files.

boot-class-path

The boot class path that is used by the bootstrap class loader to search for class files. If attribute "boot-class-path-supported" is "false" or if a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

input-arguments

The input arguments passed to the Java virtual machine which does not include the arguments to the main method. If a security manager is installed and the caller does not have ManagementPermission("monitor"), then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

start-time

The start time of the Java virtual machine in milliseconds.

system-properties

A map of names and values of all system properties. If a security manager is installed and its "checkPropertiesAccess" method does not allow access to system properties, then a "read-attribute" operation reading this attribute will fail, and the value for this attribute in the result for the "read-resource" operation will be "undefined".

uptime

The uptime of the Java virtual machine in milliseconds.

Operations

read-resource

Reads a model resource's attribute values along with either basic or complete information about any child resources

Request properties

Returns The resource's attribute values along with information about any child resources

Returned type: OBJECT

class-loading

The management interface for the class loading system of the Java virtual machine.

Attributes

verbose

Whether the verbose output for the class loading system is enabled.

total-loaded-class-count

The total number of classes that have been loaded since the Java virtual machine has started execution.

loaded-class-count

The number of classes that are currently loaded in the Java virtual machine.

unloaded-class-count

The total number of classes unloaded since the Java virtual machine has started execution.

object-name

String representation the object name of this platform managed object.

Operations

management

The management services used to control a standalone server or a host's host controller in a management domain.

Operations

security-realm

The security realms available for control access to the management services.

*

A security realm that can be associated with a management interface and used to control access to the management services.

Attributes

Operations

remove

Removes a security realm that can be associated with a management interface and used to control access to the management services.

Request properties

Returns

Returned type:

add

Adds a security realm that can be associated with a management interface and used to control access to the management services.

Request properties

Returns

Returned type:

authentication

Configuration of the server side authentication mechanisms. Optionally one truststore can be defined and one username/password based store can be defined. Authentication will first attempt to use the truststore and if this is not available will fall back to the username/password authentication. If none of these are specified the only available mechanism will be the local mechanism for the Native interface and the HTTP interface will not be accessible.

jaas

Configuration to use a JAAS LoginContext to authenticate the users.

Attributes

name

The name of the JAAS configuration to use.

Operations

remove

Removes a configuration to use JAAS for authentication.

Request properties

Returns

Returned type:

add

Adds a configuration to use JAAS for authentication.

Request properties

Returns

Returned type:

local

Configuration of the local authentication mechanism.

Attributes

default-user

The name of the default user to assume if no user specified by the remote client.

allowed-users

The comma separated list of users that will be accepted using the JBOSS-LOCAL-USER mechanism or '*' to accept all. If specified the default-user is always assumed allowed.

Operations

remove

Removes a configuration to use JBOSS-LOCAL-USER for authentication.

Request properties

Returns

Returned type:

add

Adds a configuration to use the JBOSS-LOCAL-USER mechanism for authentication.

Request properties

Returns

Returned type:

plug-in

Configuration of a user store plug-in for use by the realm.

Attributes

mechanism

Allow the mechanism this plug-in is compatible with to be overridden from DIGEST.

name

The short name of the plug-in (as registered) to use.

Operations

remove

Configuration of a user store plug-in for use by the realm.

Request properties

Returns

Returned type:

add

Add the plug-in definition.

Request properties

Returns

Returned type:

property

A configuration property to be made available to the plug-in.

*

A property within a security realm resource.

Attributes

value

The optional value of the property.

Operations

remove

Remove the property definition.

Request properties

Returns

Returned type:

add

Add a property definition.

Request properties

Returns

Returned type:

ldap

Configuration to use LDAP as the user repository.

Attributes

connection

The name of the connection to use to connect to LDAP.

advanced-filter

The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.

base-dn

The base distinguished name to commence the search for the user.

user-dn

The name of the attribute which is the user's distinguished name.

recursive

Whether the search should be recursive.

username-attribute

The name of the attribute to search for the user. This filter will then perform a simple search where the username entered by the user matches the attribute specified here.

Operations

remove

Removes a configuration to use LDAP as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use LDAP as the user repository.

Request properties

Returns

Returned type:

truststore

Configuration of a keystore to use to create a trust manager to verify clients.

Attributes

keystore-password

The password to open the keystore.

keystore-path

The path of the keystore.

keystore-relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a keystore to use to create a trust manager to verify clients.

Request properties

Returns

Returned type:

add

Adds a keystore to use to create a trust manager to verify clients.

Request properties

Returns

Returned type:

properties

Configuration to use a list users stored within a properties file as the user repository. The entries within the properties file are username={credentials} with each user being specified on it's own line.

Attributes

path

The path of the properties file containing the users.

plain-text

Are the credentials within the properties file stored in plain text. If not the credential is expected to be the hex encoded Digest hash of 'username : realm : password'.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a configuration to use a list users stored within a properties file as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use a list users stored within a properties file as the user repository.

Request properties

Returns

Returned type:

users

Configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Attributes

Operations

remove

Removes a configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Request properties

Returns

Returned type:

add

Adds a configuration to use a list users stored directly within the standalone.xml or host.xml configuration file as the user repository.

Request properties

Returns

Returned type:

user

An authorized user.

*

An authorized user.

Attributes

password

The user's password.

Operations

remove

Removes an authorized user.

Request properties

Returns

Returned type:

add

Adds an authorized user.

Request properties

Returns

Returned type:

server-identity

Configuration of the identities that represent the server.

ssl

Configuration of the SSL identity of a server or host controller.

Attributes

protocol

The protocol to use when creating the SSLContext.

keystore-relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

alias

The alias of the entry to use from the keystore.

key-password

The password to obtain the key from the keystore.

keystore-password

The password to open the keystore.

keystore-path

The path of the keystore.

Operations

remove

Removes the SSL identity of a server or host controller.

Request properties

Returns

Returned type:

add

Adds the SSL identity of a server or host controller.

Request properties

Returns

Returned type:

secret

Configuration of the secret/password-based identity of a server or host controller.

Attributes

value

The secret / password - Base64 Encoded.

Operations

remove

Removes a Adds a secret/password-based identity for a server or host controller.

Request properties

Returns

Returned type:

add

Adds a secret/password-based identity for a server or host controller.

Request properties

Returns

Returned type:

authorization

Configuration server side for loading additional user information such as roles to be used for subsequent authorization checks.

properties

Configuration to use properties file to load a users roles. The entries within the properties file are username={roles} where roles is a comma separated list of users roles.

Attributes

path

The path of the properties file containing the users roles.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.

Operations

remove

Removes a configuration to use a properties file to load a users roles.

Request properties

Returns

Returned type:

add

Adds a configuration to use a properties file to load a users roles.

Request properties

Returns

Returned type:

plug-in

Configuration of a user store plug-in for use by the realm.

Attributes

name

The short name of the plug-in (as registered) to use.

Operations

remove

Configuration of a user store plug-in for use by the realm.

Request properties

Returns

Returned type:

add

Add the plug-in definition.

Request properties

Returns

Returned type:

property

A configuration property to be made available to the plug-in.

*

A property within a security realm resource.

Attributes

value

The optional value of the property.

Operations

remove

Remove the property definition.

Request properties

Returns

Returned type:

add

Add a property definition.

Request properties

Returns

Returned type:

plug-in

An extension to the security realm allowing additional authentication / authorization modules to be loaded.

*

An extension to the security realm allowing additional authentication / authorization modules to be loaded.

Attributes

Operations

remove

Remove a plug-in from the security realm.

Request properties

Returns

Returned type:

add

Add a plug-in to the security realm.

Request properties

Returns

Returned type:

ldap-connection

Configurations of connection factories that can be used by a security realm to access LDAP servers as a source of authentication and authorization information.

*

A connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.

Attributes

initial-context-factory

The initial context factory to establish the LdapContext.

search-credential

The credential to use when connecting to perform a search.

url

The URL to use to connect to the LDAP server.

search-dn

The distinguished name to use when connecting to the LDAP server to perform searches.

Operations

remove

Removes a connection factory that was usable by a security realm to access an LDAP server as a source of authentication and authorization information.

Request properties

Returns

Returned type:

add

Adds a connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.

Request properties

Returns

Returned type:

management-interface

Interfaces exposed by the management services to allow external callers to perform management tasks.

native-interface

Configuration of the server's native management interface

Attributes

port

Deprecated -- use 'socket-binding'. The port on which the server's socket for native management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

interface

Deprecated -- use 'socket-binding'. The network interface on which the server's socket for native management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

security-realm

The security realm to use for the native management interface.

socket-binding

The name of the socket binding configuration to use for the native management interface's socket.

Operations

remove

Removes the server's native management interface

Request properties

Returns

Returned type:

add

Adds the server's native management interface

Request properties

Returns

Returned type:

http-interface

Configuration of the server's HTTP management interface

Attributes

port

Deprecated -- use 'socket-binding'. The port on which the server's socket for HTTP management communication should be opened. Must be 'undefined' if the 'socket-binding' attribute is set.

console-enabled

Flag that indicates admin console is enabled

secure-port

Deprecated -- use 'secure-socket-binding'. The port on which the server's socket for HTTPS management communication should be opened. Must be 'undefined' if the 'socket-binding' or 'secure-socket-binding' attribute is set.

interface

Deprecated -- use 'socket-binding'. The network interface on which the server's socket for HTTP management communication should be opened. Must be 'undefined' if the 'socket-binding' or 'secure-socket-binding' attribute is set.

security-realm

The security realm to use for the HTTP management interface.

socket-binding

The name of the socket binding configuration to use for the HTTP management interface's socket.

secure-socket-binding

The name of the socket binding configuration to use for the HTTPS management interface's socket.

Operations

remove

Adds the configuration of the server's HTTP management interface

Request properties

Returns

Returned type:

add

Adds the configuration of the server's HTTP management interface

Request properties

Returns

Returned type:

native-remoting-interface

Configuration of the server's native management interface using a connector from the remoting subsystem.

Attributes

Operations

remove

Removes the server's native management interface using a connector from the remoting subsystem.

Request properties

Returns

Returned type:

add

Adds the server's native management interface using a connector from the remoting subsystem.

Request properties

Returns

Returned type:

interface

A list of named network interfaces available for use on the server.

*

A named network interface, along with required criteria for determining the IP address to associate with that interface.

Attributes

name

The name of the interface.

any-address

Attribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic.

any-ipv4-address

Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0).

any-ipv6-address

Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::).

inet-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection.

link-local-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

loopback

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

loopback-address

Attribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

multicast

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection.

nic

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection.

nic-match

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection.

point-to-point

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

public-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

site-local-address

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

subnet-match

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in "slash notation"; e.g. "192.168.0.0/16". An 'undefined' value means this attribute is not relevant to the IP address selection.

up

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

virtual

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection

any

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address meets at least one of a nested set of criteria, but not necessarily all of the nested criteria. The value of the attribute is a set of criteria. An 'undefined' value means this attribute is not relevant to the IP address selection.

not

Attribute indicating that part of the selection criteria for choosing an IP address for this interface should be that the IP address *does not* meet any of a nested set of criteria. The value of the attribute is a set of criteria (e.g. 'loopback') whose normal meaning is reversed. An 'undefined' value means this attribute is not relevant to the IP address selection.

Operations

remove

Remove an interface specification.

Request properties

Returns

Returned type:

resolve-internet-address

Takes a set of interface resolution criteria and finds an IP address on the local machine that matches the criteria, or fails if no matching IP address can be found.

Request properties

Returns The IP address string in textual presentation.

Returned type: STRING

add

Add a new interface specification.

Request properties

Returns

Returned type:

socket-binding-group

A list of socket bindings available for use on the server.

*

Contains a list of socket configurations.

Attributes

port-offset

Increment to apply to the base port values defined in the socket bindings to derive the runtime values to use on this server.

default-interface

Name of an interface that should be used as the interface for any sockets that do not explicitly declare one.

name

The name of the socket binding group.

Operations

remove

Removes a socket binding group.

Request properties

Returns

Returned type:

add

Adds a socket binding group.

Request properties

Returns

Returned type:

socket-binding

Configuration information for a socket.

*

Configuration information for a socket.

Attributes

port

Number of the port to which the socket should be bound.

bound-port

The port to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.

interface

Name of the interface to which the socket should be bound, or, for multicast sockets, the interface on which it should listen. This should be one of the declared interfaces.

fixed-port

Whether the port value should remain fixed even if numeric offsets are applied to the other sockets in the socket group.

client-mappings

Specifies zero or more client mappings for this socket binding. A client connecting to this socket should use the destination address specified in the mapping that matches its desired outbound interface. This allows for advanced network topologies that use either network address translation, or have bindings on multiple network interfaces to function. Each mapping should be evaluated in declared order, with the first successful match used to determine the destination.

multicast-port

Port on which the socket should receive multicast traffic. Must be configured if 'multicast-address' is configured.

bound-address

The address to which the actual socket using this socket binding configuration has been bound, or undefined if no socket has been bound.

name

The name of the socket. Services which need to access the socket configuration information will find it using this name.

multicast-address

Multicast address on which the socket should receive multicast traffic. If unspecified, the socket will not be configured to receive multicast.

bound

Whether an actual socket using this socket binding configuration has been bound.

Operations

remove

Removes a socket binding configuration from the group.

Request properties

Returns

Returned type:

add

Adds a socket binding configuration to the group.

Request properties

Returns

Returned type:

remote-destination-outbound-socket-binding

Configuration information for a, remote destination, outbound socket binding.

*

Configuration information for a, remote destination, outbound socket binding.

Attributes

port

The port number of the remote destination to which the outbound socket should connect.

host

The host name or the IP address of the remote destination to which this outbound socket will connect.

source-interface

The name of the interface which will be used for the source address of the outbound socket.

source-port

The port number which will be used as the source port of the outbound socket.

fixed-source-port

Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.

Operations

remove

Removes a remote destination outbound socket binding, from a socket binding group

Request properties

Returns

Returned type:

add

Adds a remote destination outbound socket binding, to a socket binding group

Request properties

Returns

Returned type:

local-destination-outbound-socket-binding

Configuration information for a, local destination, outbound socket binding.

*

Configuration information for a, local destination, outbound socket binding.

Attributes

source-port

The port number which will be used as the source port of the outbound socket.

source-interface

The name of the interface which will be used for the source address of the outbound socket.

fixed-source-port

Whether the port value should remain fixed even if numeric offsets are applied to the other outbound sockets in the socket group.

socket-binding-ref

The name of the local socket-binding which will be used to determine the port to which this outbound socket connects.

Operations

remove

Removes a local destination outbound socket binding, from a socket binding group

Request properties

Returns

Returned type:

add

Adds a local destination outbound socket binding, to a socket binding group

Request properties

Returns

Returned type:

deployment

A list of deployments available for use on the server.

*

A deployment represents anything that can be deployed (e.g. an application such as EJB-JAR, WAR, EAR, any kind of standard archive such as RAR or JBoss-specific deployment) into a server.

Attributes

name

Unique identifier of the deployment. Must be unique across all deployments.

runtime-name

Name by which the deployment should be known within a server's runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same 'runtime-name' (e.g. two versions of "foo.war") both available in the deployment content repository, in which case the deployments would need to have distinct 'name' values but would have the same 'runtime-name'.

content

List of pieces of content that comprise the deployment.

enabled

Boolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.)

persistent

Boolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment.

status

The current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was not enabled or was manually stopped.

Operations

redeploy

Undeploy existing content from the runtime and deploy it again.

Request properties

Returns

Returned type:

remove

Remove a deployment from the list of content available for use. If the deployment is currently deployed in the runtime it will first be undeployed.

Request properties

Returns

Returned type:

undeploy

Undeploy content from the runtime. The content remains in the list of content available for use.

Request properties

Returns

Returned type:

deploy

Deploy the specified deployment content into the runtime, optionally replacing existing content.

Request properties

Returns

Returned type:

add

Adds previously uploaded content to the list of content available for use. Does not actually deploy the content unless the 'enabled' parameter is 'true'.

Request properties

Returns

Returned type:

subsystem

Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.

web

Runtime resources exposed by web components in the deployment.

Attributes

expired-sessions

Number of sessions that have expired

rejected-sessions

Number of rejected sessions

max-active-sessions

Max number of concurrent active sessions

session-max-alive-time

The longest time (in seconds) that an expired session had been alive

sessions-created

Total sessions created

session-avg-alive-time

Average time (in seconds) that expired sessions had been alive

context-root

The context root of the web application

virtual-host

The name of the virtual host on which the web application is served

active-sessions

Number of active sessions

duplicated-session-ids

Number of duplicated session IDs generated by the random source (anything bigger than 0 means problems)

servlet

Runtime information about the servlets in the deployment.

*

Runtime information about the servlets in the deployment.

Attributes

min-time

Minimum processing time of a request

load-time

Load time

processingTime

Total execution time of the servlet's service method

maxTime

Maximum processing time of a request

requestCount

Number of requests processed by this servlet

datasources

Runtime resources exposed by data sources included in this deployment.

Attributes

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

data-source

A JDBC data-source configuration

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

messaging

Runtime resources exposed by messaging resources included in this deployment.

Attributes

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

path

webservices

Runtime resources exposed by web service components in the deployment.

Attributes

endpoint

Webservice endpoint.

*

Webservice endpoint.

Attributes

name

Webservice endpoint name.

context

Webservice endpoint context.

class

Webservice endpoint class.

type

Webservice endpoint type.

wsdl-url

Webservice endpoint WSDL URL.

average-processing-time

Average endpoint processing time.

min-processing-time

Minimal endpoint processing time.

max-processing-time

Maximal endpoint processing time.

total-processing-time

Total endpoint processing time.

request-count

Count of requests the endpoint processed.

response-count

Count of responses the endpoint generated.

fault-count

Count of faults the endpoint generated.

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

hibernate-persistence-unit

Persistence unit

*

Runtime information about Hibernate use in the deployment.

Attributes

entity-delete-count

Get number of entity deletes.

entity-insert-count

Get number of entity inserts.

entity-load-count

Get number of entity loads.

entity-fetch-count

Get number of entity fetches.

entity-update-count

Get number of entity updates.

query-execution-count

Get number of executed queries.

query-execution-max-time

Get the time in milliseconds of the slowest query.

query-execution-max-time-query-string

Get the query string for the slowest query.

query-cache-hit-count

Get the number of cached queries successfully retrieved from cache.

query-cache-miss-count

Get the number of cached queries not found in cache.

query-cache-put-count

Get the number of cacheable queries put in cache.

flush-count

Get the number of flushes executed by sessions (either implicit or explicit).

connect-count

Get the number of connections asked for by the sessions.

second-level-cache-hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

second-level-cache-miss-count

Number of cacheable entities/collections not found in the cache and loaded.

second-level-cache-put-count

Number of cacheable entities/collections put in the cache.

session-close-count

Number of sessions closed.

session-open-count

Number of sessions opened.

collection-load-count

Number of collections loaded.

collection-fetch-count

Number of collections fetched.

collection-update-count

Number of collections updated.

collection-remove-count

Number of collections removed.

collection-recreated-count

Number of collections recreated.

successful-transaction-count

Number of successful transactions.

completed-transaction-count

Number of completed transactions.

prepared-statement-count

Number of acquired prepared statements.

close-statement-count

Number of released prepared statements.

optimistic-failure-count

Number of optimistic lock exceptions.

enabled

Determine if statistics are enabled.

Operations

summary

Log the statistics.

Request properties

Returns

Returned type:

clear

Clear statistics.

Request properties

Returns

Returned type:

evict-all

Evict all entities from second level cache.

Request properties

Returns

Returned type:

entity-cache

Statistics for a Hibernate Second Level Cache region.

*

Statistics for a Hibernate Second Level Cache region.

Attributes

miss-count

Number of cacheable entities/collections not found in the cache and loaded.

put-count

Number of cacheable entities/collections put in the cache.

element-count-in-memory

Number of cacheable entities/collections currently stored in memory.

hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

query-cache

Statistics for individual queries.

*

Statistics for individual queries.

Attributes

query-execution-count

Get number of times query has been executed.

query-execution-max-time

Get the time in milliseconds of the query.

query-execution-min-time

Get the minimum time in milliseconds of the query.

query-name

Query name.

query-execution-average-time

Get the average time in milliseconds of the query.

query-cache-miss-count

Get the number of times query was not found in cache.

query-execution-row-count

Get number of rows returned from executions of query.

query-cache-hit-count

Get the number of times query was retrieved from cache.

query-cache-put-count

Get the number of times query was put in cache.

entity

Statistics for individual entities.

*

Statistics for individual entities.

Attributes

entity-load-count

Get number of entity loads.

entity-update-count

Get number of entity updates.

optimistic-failure-count

Number of optimistic lock exceptions.

entity-fetch-count

Get number of entity fetches.

entity-insert-count

Get number of entity inserts.

entity-delete-count

Get number of entity deletes.

collection

Statistics for individual collections.

*

Statistics for individual collections.

Attributes

collection-fetch-count

Number of times collection was fetched.

collection-recreated-count

Number of times collection was recreated.

collection-load-count

Number of times collection was loaded.

collection-update-count

Number of times collection was updated.

collection-remove-count

Number of times collection was removed.

ejb3

Runtime resources exposed by EJBs components included in this deployment.

Attributes

message-driven-bean

Message driven bean component included in the deployment.

*

Message driven bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

singleton-bean

Singleton bean component included in the deployment.

*

Singleton bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

timers

EJB timers associated with the component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

stateless-session-bean

Stateless session bean component included in the deployment.

*

Stateless session bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

entity-bean

Entity bean component included in the deployment.

*

Entity bean component included in the deployment.

Attributes

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

stateful-session-bean

Stateful session bean component included in the deployment.

*

Stateful session bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

subdeployment

Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.

*

Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.

Attributes

subsystem

Runtime resources created when the deployment is deployed, organized by the subsystem responsible for the runtime resource.

web

Runtime resources exposed by web components in the deployment.

Attributes

expired-sessions

Number of sessions that have expired

rejected-sessions

Number of rejected sessions

max-active-sessions

Max number of concurrent active sessions

session-max-alive-time

The longest time (in seconds) that an expired session had been alive

sessions-created

Total sessions created

session-avg-alive-time

Average time (in seconds) that expired sessions had been alive

context-root

The context root of the web application

virtual-host

The name of the virtual host on which the web application is served

active-sessions

Number of active sessions

duplicated-session-ids

Number of duplicated session IDs generated by the random source (anything bigger than 0 means problems)

servlet

Runtime information about the servlets in the deployment.

*

Runtime information about the servlets in the deployment.

Attributes

min-time

Minimum processing time of a request

load-time

Load time

processingTime

Total execution time of the servlet's service method

maxTime

Maximum processing time of a request

requestCount

Number of requests processed by this servlet

datasources

Runtime resources exposed by data sources included in this deployment.

Attributes

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

data-source

A JDBC data-source configuration

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

messaging

Runtime resources exposed by messaging resources included in this deployment.

Attributes

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

path

webservices

Runtime resources exposed by web service components in the deployment.

Attributes

endpoint

Webservice endpoint.

*

Webservice endpoint.

Attributes

name

Webservice endpoint name.

context

Webservice endpoint context.

class

Webservice endpoint class.

type

Webservice endpoint type.

wsdl-url

Webservice endpoint WSDL URL.

average-processing-time

Average endpoint processing time.

min-processing-time

Minimal endpoint processing time.

max-processing-time

Maximal endpoint processing time.

total-processing-time

Total endpoint processing time.

request-count

Count of requests the endpoint processed.

response-count

Count of responses the endpoint generated.

fault-count

Count of faults the endpoint generated.

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

hibernate-persistence-unit

Persistence unit

*

Runtime information about Hibernate use in the deployment.

Attributes

entity-delete-count

Get number of entity deletes.

entity-insert-count

Get number of entity inserts.

entity-load-count

Get number of entity loads.

entity-fetch-count

Get number of entity fetches.

entity-update-count

Get number of entity updates.

query-execution-count

Get number of executed queries.

query-execution-max-time

Get the time in milliseconds of the slowest query.

query-execution-max-time-query-string

Get the query string for the slowest query.

query-cache-hit-count

Get the number of cached queries successfully retrieved from cache.

query-cache-miss-count

Get the number of cached queries not found in cache.

query-cache-put-count

Get the number of cacheable queries put in cache.

flush-count

Get the number of flushes executed by sessions (either implicit or explicit).

connect-count

Get the number of connections asked for by the sessions.

second-level-cache-hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

second-level-cache-miss-count

Number of cacheable entities/collections not found in the cache and loaded.

second-level-cache-put-count

Number of cacheable entities/collections put in the cache.

session-close-count

Number of sessions closed.

session-open-count

Number of sessions opened.

collection-load-count

Number of collections loaded.

collection-fetch-count

Number of collections fetched.

collection-update-count

Number of collections updated.

collection-remove-count

Number of collections removed.

collection-recreated-count

Number of collections recreated.

successful-transaction-count

Number of successful transactions.

completed-transaction-count

Number of completed transactions.

prepared-statement-count

Number of acquired prepared statements.

close-statement-count

Number of released prepared statements.

optimistic-failure-count

Number of optimistic lock exceptions.

enabled

Determine if statistics are enabled.

Operations

summary

Log the statistics.

Request properties

Returns

Returned type:

clear

Clear statistics.

Request properties

Returns

Returned type:

evict-all

Evict all entities from second level cache.

Request properties

Returns

Returned type:

entity-cache

Statistics for a Hibernate Second Level Cache region.

*

Statistics for a Hibernate Second Level Cache region.

Attributes

miss-count

Number of cacheable entities/collections not found in the cache and loaded.

put-count

Number of cacheable entities/collections put in the cache.

element-count-in-memory

Number of cacheable entities/collections currently stored in memory.

hit-count

Number of cacheable entities/collections successfully retrieved from the cache.

query-cache

Statistics for individual queries.

*

Statistics for individual queries.

Attributes

query-execution-count

Get number of times query has been executed.

query-execution-max-time

Get the time in milliseconds of the query.

query-execution-min-time

Get the minimum time in milliseconds of the query.

query-name

Query name.

query-execution-average-time

Get the average time in milliseconds of the query.

query-cache-miss-count

Get the number of times query was not found in cache.

query-execution-row-count

Get number of rows returned from executions of query.

query-cache-hit-count

Get the number of times query was retrieved from cache.

query-cache-put-count

Get the number of times query was put in cache.

entity

Statistics for individual entities.

*

Statistics for individual entities.

Attributes

entity-load-count

Get number of entity loads.

entity-update-count

Get number of entity updates.

optimistic-failure-count

Number of optimistic lock exceptions.

entity-fetch-count

Get number of entity fetches.

entity-insert-count

Get number of entity inserts.

entity-delete-count

Get number of entity deletes.

collection

Statistics for individual collections.

*

Statistics for individual collections.

Attributes

collection-fetch-count

Number of times collection was fetched.

collection-recreated-count

Number of times collection was recreated.

collection-load-count

Number of times collection was loaded.

collection-update-count

Number of times collection was updated.

collection-remove-count

Number of times collection was removed.

ejb3

Runtime resources exposed by EJBs components included in this deployment.

Attributes

message-driven-bean

Message driven bean component included in the deployment.

*

Message driven bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

singleton-bean

Singleton bean component included in the deployment.

*

Singleton bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

timers

EJB timers associated with the component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

stateless-session-bean

Stateless session bean component included in the deployment.

*

Stateless session bean component included in the deployment.

Attributes

timers

EJB timers associated with the component.

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

entity-bean

Entity bean component included in the deployment.

*

Entity bean component included in the deployment.

Attributes

pool-available-count

The number of available (i.e. not in use) instances in the pool.

peak-concurrent-invocations

Peak concurrent invocations.

invocations

Number of invocations processed.

pool-create-count

The number of bean instances that have been created.

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

pool-name

The name of the pool.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

pool-max-size

The maximum size of the pool.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

pool-remove-count

The number of bean instances that have been removed.

pool-current-size

The current size of the pool.

stateful-session-bean

Stateful session bean component included in the deployment.

*

Stateful session bean component included in the deployment.

Attributes

declared-roles

The roles declared (via @DeclareRoles) on this EJB component.

security-domain

The security domain for this EJB component.

peak-concurrent-invocations

Peak concurrent invocations.

run-as-role

The run-as role (if any) for this EJB component.

component-class-name

The component's class name.

invocations

Number of invocations processed.

wait-time

Time spend waiting to obtain an instance.

execution-time

Time spend within a bean method.

subsystem

The subsystems that make up the server's profile.

jaxrs

The configuration of the JAX-RS subsystem.

Attributes

Operations

remove

Operation removing the JAX-RS subsystem.

Request properties

Returns

Returned type:

add

Operation creating the JAX-RS subsystem.

Request properties

Returns

Returned type:

jacorb

The JacORB subsystem configuration.

Attributes

transactions

Indicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts.

support-ssl

Indicates whether SSL is to be supported (on) or not (off).

socket-binding

The name of the socket binding configuration that specifies the ORB port.

pool-size

The size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise.

cache-poa-names

Indicates whether POA names should be cached (on) or not (off).

add-component-via-interceptor

Indicates whether SSL components should be added by an IOR interceptor (on) or not (off).

max-managed-buf-size

The log2 of maximum size managed by the internal buffer manager.

client-timeout

The client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out.

server-supports

Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).

queue-wait

Indicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full.

giop-minor-version

The GIOP minor version to be used.

monitoring

Indicates whether the monitoring GUI should be displayed (on) or not (off).

server-requires

Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).

client-supports

Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth).

properties

A list of generic key/value properties.

root-context

The naming service root context.

comet

Indicates whether interoperability with Comet's ORB is enabled (on) or not (off).

ssl-socket-binding

The name of the socket binding configuration that specifies the ORB SSL port.

client-requires

Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth).

max-server-connections

The maximum number of connections accepted by the server.

iona

Indicates whether interoperability with IONA's ASP is enabled (on) or not (off).

chunk-custom-rmi-valuetypes

Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off).

queue-max

The maximum number of requests that can be queued.

print-version

Indicates whether the version number should be printed during ORB startup (on) or not (off).

server-timeout

The server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out.

security

Indicates whether the security interceptors are to be installed (on) or not (off).

sun

Indicates whether interoperability with Sun's ORB is enabled (on) or not (off).

lax-boolean-encoding

Indicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off).

strict-check-on-tc-creation

Indicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off).

use-imr

Indicates whether the implementation repository should be used (on) or not (off).

name

The name of the running ORB.

max-threads

The maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job.

use-bom

Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off).

cache-typecodes

Indicates whether typecodes should be cached (on) or not (off).

indirection-encoding-disable

Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off).

queue-min

The size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests.

retry-interval

The interval in milliseconds between retries.

outbuf-cache-timeout

The buffer cache timeout in milliseconds.

outbuf-size

The size of the network buffers for outgoing messages.

security-domain

The name of the security domain that holds the key and trust stores that will be used to establish SSL connections.

retries

The number of retries if connections cannot be promptly established.

export-corbaloc

Indicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off).

Operations

remove

Removes the JacORB subsystem.

Request properties

Returns

Returned type:

add

Adds the JacORB subsystem.

Request properties

Returns

Returned type:

jaxr

The configuration of the JAXR subsystem.

Attributes

jndi-name

The JNDI name under which the JAXR ConnectionFactory is bound

class

The JAXR ConnectionFactory implementation class

Operations

remove

Removes the JAXR subsystem.

Request properties

Returns

Returned type:

add

Adds the JAXR subsystem.

Request properties

Returns

Returned type:

property

A JAXR property. The identity of the resource defines the property name.

*

A JAXR property. The identity of the resource defines the property name.

Attributes

value

The JAXR property value.

Operations

remove

Remove a JAXR property

Request properties

Returns

Returned type:

add

Add a JAXR property

Request properties

Returns

Returned type:

jsf

The JSF (Mojarra) subsystem

Attributes

Operations

remove

Removes the JSF subsystem

Request properties

Returns

Returned type:

add

Adds the JSF subsystem

Request properties

Returns

Returned type:

jmx

The configuration of the JMX subsystem.

Attributes

Operations

remove

Removes the JMX subsystem.

Request properties

Returns

Returned type:

add

Adds the JMX subsystem.

Request properties

Returns

Returned type:

show-model

Expose the model controller in the MBeanServer. The recommended is the 'expression' child.

expression

The configuration for exposing the 'expression' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as String. Reads return the unresolved expression. You may use expressions when writing attributes and setting operation parameters.

Attributes

domain-name

The domain name to use for the 'expression' model controller JMX facade in the MBeanServer.

Operations

remove

Removes the 'expression' model controller JMX facade from the MBeanServer.

Request properties

Returns

Returned type:

add

Adds the 'expression' model controller JMX facade to the MBeanServer.

Request properties

Returns

Returned type:

resolved

The configuration for exposing the 'resolved' model controller in the MBeanServer. This facade will expose all simple attributes and operation parameters as their type in the underlying model. Reads return the resolved expression if used, or the raw value. You may not use expressions when writing attributes and setting operation parameters.

Attributes

domain-name

The domain name to use for the 'resolved' model controller JMX facade in the MBeanServer.

proper-property-format

If false, PROPERTY type attributes are represented as a DMR string, this is the legacy behaviour. If true, PROPERTY type attributes are represented by a composite type where the key is a string, and the value has the same type as the property in the underlying model.

Operations

remove

Removes the 'resolved' model controller JMX facade from the MBeanServer.

Request properties

Returns

Returned type:

add

Adds the 'resolved' model controller JMX facade to the MBeanServer.

Request properties

Returns

Returned type:

remoting-connector

JBoss remoting connectors for the JMX subsystem.

jmx

A JBoss remoting connector for the JMX subsystem.

Attributes

use-management-endpoint

If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one

Operations

remove

Removes the remote connector for the JMX subsystem.

Request properties

Returns

Returned type:

add

Adds the remote connector for the JMX subsystem.

Request properties

Returns

Returned type:

jca

The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters

Operations

remove

Remove the JCA subsystem

Request properties

Returns

Returned type:

add

Add the JCA subsystem

Request properties

Returns

Returned type:

archive-validation

Archive validation for resource adapters

archive-validation

jca.archive-validation

Attributes

enabled

Specify whether archive validation is enabled

fail-on-error

Should an archive validation error report fail the deployment

fail-on-warn

Should an archive validation warning report fail the deployment

Operations

remove

Remove archive validation functionality

Request properties

Returns

Returned type:

add

Add archive validation functionality

Request properties

Returns

Returned type:

bean-validation

Bean validation (JSR-303) for resource adapters

bean-validation

jca.bean-validation

Attributes

enabled

Specify whether bean validation is enabled

Operations

remove

Remove bean validation functionality

Request properties

Returns

Returned type:

add

Add bean validation functionality

Request properties

Returns

Returned type:

bootstrap-context

Bootstrap context for resource adapters

*

jca.bootstrap-context

Attributes

name

The name of the BootstrapContext

workmanager

The WorkManager instance for the BootstrapContext

Operations

remove

Remove BootstrapContext

Request properties

Returns

Returned type:

add

Add BootstrapContext

Request properties

Returns

Returned type:

workmanager

WorkManager for resource adapters

*

jca.workmanager

Attributes

name

The name of the WorkManager

Operations

remove

Remove work manager

Request properties

Returns

Returned type:

add

Add work manager

Request properties

Returns

Returned type:

long-running-threads

boolean indicating if service for long running activated

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

short-running-threads

boolean indicating if service for short running activated

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

cached-connection-manager

Cached connection manager for resource adapters

cached-connection-manager

jca.cached-connection-manager

Attributes

debug

Enable/disable debug information logging

error

Enable/disable error information logging

install

Enable/disable the cached connection manager valve and interceptor

Operations

remove

Remove cached connection manager functionality

Request properties

Returns

Returned type:

add

Add cached connection manager functionality

Request properties

Returns

Returned type:

threads

The threading subsystem, used to declare manageable thread pools and resources.

Attributes

Operations

remove

Removes the threading subsystem.

Request properties

Returns

Returned type:

add

Adds the threading subsystem.

Request properties

Returns

Returned type:

bounded-queue-thread-pool

A set of thread pools where tasks are stored in a bounded-size queue and where if no space is available in the queue tasks will either be discarded or passed off to another 'handoff-executor' for execution.

*

A thread pool executor with a bounded queue where threads submittings tasks will not block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a bounded queue thread pool.

Request properties

Returns

Returned type:

queueless-thread-pool

A set of thread pools where are not queued and where if no pool thread is available to handle a task the tasks will either be discarded or passed off to another 'handoff-executor' for execution.

*

A thread pool executor with no queue where threads submittings tasks will not block. When a task is submitted, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the task is handed off to the designated handoff executor, if one is specified. Otherwise, the task is discarded.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

handoff-executor

An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

current-thread-count

The current number of threads in the pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a queueless thread pool.

Request properties

Returns

Returned type:

unbounded-queue-thread-pool

A set of thread pools where tasks are stored in a queue with no maximum size.

*

A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.

Attributes

active-count

The approximate number of threads that are actively executing tasks.

current-thread-count

The current number of threads in the pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

completed-task-count

The approximate total number of tasks that have completed execution.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been rejected.

Operations

remove

Removes an unbounded thread pool.

Request properties

Returns

Returned type:

add

Adds an unbounded thread pool.

Request properties

Returns

Returned type:

thread-factory

A set of thread factories.

*

A thread factory (implementing java.util.concurrent.ThreadFactory).

Attributes

thread-name-pattern

The template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID.

group-name

Specifies the name of a thread group to create for this thread factory.

priority

May be used to specify the thread priority of created threads.

name

The name of the created thread factory.

Operations

remove

Removes a thread factory

Request properties

Returns

Returned type:

add

Adds a thread factory

Request properties

Returns

Returned type:

blocking-bounded-queue-thread-pool

A set of thread pools where tasks are stored in a bounded-size queue and where threads submitting tasks will block until space is available in the queue.

*

A thread pool executor with a bounded queue where threads submittings tasks may block. Such a thread pool has a core and maximum size and a specified queue length. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, if there is room in the queue, the task is enqueued. Otherwise, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the caller blocks until room becomes available in the queue.

Attributes

core-threads

The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.

current-thread-count

The current number of threads in the pool.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

queue-length

The queue length.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

allow-core-timeout

Whether core threads may time out.

Operations

remove

Removes a blocking bounded queue thread pool.

Request properties

Returns

Returned type:

add

Adds a blocking bounded queue thread pool.

Request properties

Returns

Returned type:

blocking-queueless-thread-pool

A set of thread pools where are not queued and where threads submitting tasks will block until a pool thread is available to execute the task.

*

A thread pool executor with no queue where threads submittings tasks may block. When a task is submitted, if the number of running threads is less than the maximum size, a new thread is created. Otherwise, the caller blocks until another thread completes its task and accepts the new one.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

current-thread-count

The current number of threads in the pool.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a blocking queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a blocking queueless thread pool.

Request properties

Returns

Returned type:

scheduled-thread-pool

A set of scheduled thread pools.

*

A scheduled thread pool executor.

Attributes

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

active-count

The approximate number of threads that are actively executing tasks.

completed-task-count

The approximate total number of tasks that have completed execution.

current-thread-count

The current number of threads in the pool.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

Operations

remove

Removes a queueless thread pool.

Request properties

Returns

Returned type:

add

Adds a queueless thread pool.

Request properties

Returns

Returned type:

webservices

The configuration of the web services subsystem.

Attributes

modify-wsdl-address

Whether the soap address can be modified.

wsdl-host

The WSDL, that is a required deployment artifact for an endpoint, has a element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the

wsdl-port

The non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

wsdl-secure-port

The secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors.

Operations

remove

Removes the web services subsystem.

Request properties

Returns

Returned type:

add

Adds the web services subsystem.

Request properties

Returns

Returned type:

endpoint-config

Webservice endpoint configuration

*

Webservice endpoint configuration

Operations

remove

Remove endpoint configuration

Request properties

Returns

Returned type:

add

Add endpoint configuration

Request properties

Returns

Returned type:

pre-handler-chain

Endpoint configuration PRE handler chain

*

Endpoint configuration PRE handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Endpoint configuration PRE handler chain

Request properties

Returns

Returned type:

add

Endpoint configuration PRE handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

post-handler-chain

Endpoint configuration POST handler chain

*

Endpoint configuration POST handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Endpoint configuration POST handler chain

Request properties

Returns

Returned type:

add

Endpoint configuration POST handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

property

Endpoint configuration property

*

Endpoint configuration property

Attributes

value

Endpoint configuration property value

Operations

remove

Remove endpoint configuration property

Request properties

Returns

Returned type:

add

Add endpoint configuration property

Request properties

Returns

Returned type:

client-config

Webservice client configuration

*

Webservice client configuration

Operations

remove

Remove client configuration

Request properties

Returns

Returned type:

add

Add client configuration

Request properties

Returns

Returned type:

pre-handler-chain

Client configuration PRE handler chain

*

Client configuration PRE handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Client configuration PRE handler chain

Request properties

Returns

Returned type:

add

Client configuration PRE handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

post-handler-chain

Client configuration POST handler chain

*

Client configuration POST handler chain

Attributes

protocol-bindings

Protocol binding

Operations

remove

Client configuration POST handler chain

Request properties

Returns

Returned type:

add

Client configuration POST handler chain

Request properties

Returns

Returned type:

handler

Endpoint handler

*

Endpoint handler

Attributes

class

Handler class

Operations

remove

Handler name

Request properties

Returns

Returned type:

add

Handler name

Request properties

Returns

Returned type:

property

Client configuration property

*

Client configuration property

Attributes

value

Client configuration property value

Operations

remove

Remove client configuration property

Request properties

Returns

Returned type:

add

Add client configuration property

Request properties

Returns

Returned type:

sar

The SAR subsystem allowing you to deploy sar archives containing MBeans configured by META-INF/jboss-service.xml

Attributes

Operations

remove

Removes the SAR subsystem

Request properties

Returns

Returned type:

add

Adds the SAR subsystem

Request properties

Returns

Returned type:

configadmin

The ConfigAdmin subsystem configuration.

Operations

remove

Remove the ConfigAdmin subsystem configuration.

Request properties

Returns

Returned type:

add

Add the ConfigAdmin subsystem configuration.

Request properties

Returns

Returned type:

configuration

A Configuration Admin Service entry. The identity of the resource defines the Configuration Admin PID (Persistent Identifier) that entries are associated with.

*

A Configuration Admin Service entry. The identity of the resource defines the Configuration Admin PID (Persistent Identifier) that entries are associated with.

Attributes

entries

The list of configuration entries.

Operations

update

Update a configuration entry.

Request properties

Returns

Returned type:

remove

Remove a configuration entry.

Request properties

Returns

Returned type:

add

Add a configuration entry.

Request properties

Returns

Returned type:

remoting

The configuration of the Remoting subsystem.

Attributes

worker-read-threads

The number of read threads to create for the remoting worker.

worker-task-max-threads

The maximum number of threads for the remoting worker task thread pool.

worker-task-limit

The maximum number of remoting worker tasks to allow before rejecting.

worker-task-core-threads

The number of core threads for the remoting worker task thread pool.

worker-write-threads

The number of write threads to create for the remoting worker.

worker-task-keepalive

The number of milliseconds to keep non-core remoting worker task threads alive.

Operations

remove

Removes the Remoting subsystem.

Request properties

Returns

Returned type:

add

Adds the Remoting subsystem.

Request properties

Returns

Returned type:

outbound-connection

Remoting outbound connections.

*

Remoting outbound connection.

Attributes

uri

The connection URI for the outbound connection.

Operations

remove

Removes a generic URI based remoting outbound connection.

Request properties

Returns

Returned type:

add

Adds a generic URI based remoting outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

remote-outbound-connection

Remoting outbound connections for remote:// URI scheme.

*

Remoting outbound connection with a implicit remote:// URI scheme.

Attributes

outbound-socket-binding-ref

Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.

username

The user name to use when authenticating against the remote server.

security-realm

Reference to the security realm to use to obtain the password and SSL configuration.

Operations

remove

Removes a remote:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

add

Adds a remote:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

connector

The remoting connectors.

*

The configuration of a Remoting connector.

Attributes

authentication-provider

The "authentication-provider" element contains the name of the authentication provider to use for incoming connections.

socket-binding

The name (or names) of the socket binding(s) to attach to.

security-realm

The associated security realm to use for authentication for this connector.

Operations

remove

Removes a remoting connector.

Request properties

Returns

Returned type:

add

Adds a Remoting connector.

Request properties

Returns

Returned type:

security

Configuration of security for this connector.

sasl

The "sasl" element contains the SASL authentication configuration for this connector.

Attributes

qop

The optional nested "qop" element contains a list of quality-of-protection values, in decreasing order of preference.

include-mechanisms

The optional nested "include-mechanisms" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.

strength

The optional nested "strength" element contains a list of cipher strength values, in decreasing order of preference.

server-auth

The optional nested "server-auth" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.

reuse-session

The optional nested "reuse-session" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.

Operations

remove

Removes the SASL authentication configuration for its connector

Request properties

Returns

Returned type:

add

Adds the SASL authentication configuration for its connector

Request properties

Returns

Returned type:

sasl-policy

Specifies an optional policy to use to narrow down the available set of mechanisms.

policy

The policy configuration.

Attributes

forward-secrecy

The optional nested "forward-secrecy" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.

no-plain-text

The optional nested "no-plain-text" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted. "false" to permit, "true" to deny.

no-active

The optional nested "no-active" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. "false" to permit, "true" to deny.

pass-credentials

The optional nested "pass-credentials" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.

no-dictionary

The optional nested "no-dictionary" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. "false" to permit, "true" to deny.

no-anonymous

The optional nested "no-anonymous" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. "false" to permit, "true" to deny.

Operations

remove

Removes the SASL policy.

Request properties

Returns

Returned type:

add

Adds the SASL policy.

Request properties

Returns

Returned type:

property

Properties to further configure sasl.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

property

Properties to further configure the connector.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

local-outbound-connection

Remoting outbound connections for local:// URI scheme.

*

Remoting outbound connection with a implicit local:// URI scheme.

Attributes

outbound-socket-binding-ref

Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.

Operations

remove

Removes a local:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

add

Adds a local:// URI scheme based outbound connection.

Request properties

Returns

Returned type:

property

The XNIO Options that will be used during the connection creation.

*

Properties supported by the underlying provider. The property name is inferred from the last element of the properties address.

Attributes

value

The property value.

Operations

remove

Removes a property.

Request properties

Returns

Returned type:

add

Adds a property.

Request properties

Returns

Returned type:

infinispan

The configuration of the infinispan subsystem

Operations

remove

Remove the infinispan subsystem

Request properties

Returns

Returned type:

add

Add the infinispan subsystem

Request properties

Returns

Returned type:

cache-container

The configuration of an infinispan cache container

*

The configuration of an infinispan cache container

Attributes

default-cache

The default infinispan cache

aliases

The list of aliases for this cache container

jndi-name

The jndi name to which to bind this cache container

start

The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

listener-executor

The executor used for the replication queue

eviction-executor

The scheduled executor used for eviction

replication-queue-executor

The executor used for asynchronous cache operations

module

The module whose class loader should be used when building this cache container's configuration.

Operations

remove-alias

Remove an alias for this cache container

Request properties

Returns

Returned type:

remove

Remove a cache container from the infinispan subsystem

Request properties

Returns

Returned type:

add-alias

Add an alias for this cache container

Request properties

Returns

Returned type:

add

Add a cache container to the infinispan subsystem

Request properties

Returns

Returned type:

transport

The description of the transport used by this cache container

TRANSPORT

The description of the transport used by this cache container

Attributes

stack

The jgroups stack to use for the transport

cluster

The name of the group communication cluster

executor

The executor to use for the transport

lock-timeout

The timeout for locks for the transport

Operations

remove

Remove the transport from the cache container

Request properties

Returns

Returned type:

add

Add the transport to the cache container

Request properties

Returns

Returned type:

local-cache

A local cache

*

A local cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a local cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

invalidation-cache

An invalidation cache

*

An invalidation cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add an invalidation cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

replicated-cache

A replicated cache

*

A replicated cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a replicated cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

state-transfer

The state transfer configuration for distribution and replicated caches.

STATE_TRANSFER

The state transfer configuration for distribution and replicated caches.

Attributes

enabled

If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.

timeout

The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.

chunk-size

The size, in bytes, in which to batch the transfer of cache entries.

Operations

remove

Remove a state transfer configuration.

Request properties

Returns

Returned type:

add

Add a state transfer configuration.

Request properties

Returns

Returned type:

distributed-cache

A distributed cache

*

A distributed cache

Attributes

start

The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start).

batching

If enabled, the invocation batching API will be made available for this cache.

indexing

If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed.

jndi-name

The jndi-name to which to bind this cache instance.

module

The module whose class loader should be used when building this cache's configuration.

indexing-properties

Properties to control indexing behaviour

async-marshalling

If enabled, this will cause marshalling of entries to be performed asynchronously.

mode

Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation.

queue-size

In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold.

queue-flush-interval

In ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds.

remote-timeout

In SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown.

owners

Number of cluster-wide replicas for each cache entry.

virtual-nodes

Controls the number of virtual nodes per "real" node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used.

l1-lifespan

Maximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.

Operations

remove

Remove a cache from this container.

Request properties

Returns

Returned type:

add

Add a distributed cache to this cache container

Request properties

Returns

Returned type:

locking

The locking configuration of the cache.

LOCKING

The locking configuration of the cache.

Attributes

isolation

Sets the cache locking isolation level.

striping

If true, a pool of shared locks is maintained for all entries that need to be locked. Otherwise, a lock is created per entry in the cache. Lock striping helps control memory footprint but may reduce concurrency in the system.

acquire-timeout

Maximum time to attempt a particular lock acquisition.

concurrency-level

Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan.

Operations

remove

Removes a locking configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a locking configuration element to the cache.

Request properties

Returns

Returned type:

transaction

The cache transaction configuration.

TRANSACTION

The cache transaction configuration.

Attributes

mode

Sets the cache transaction mode to one of NONE, NON_XA, NON_DURABLE_XA, FULL_XA.

stop-timeout

If there are any ongoing transactions when a cache is stopped, Infinispan waits for ongoing remote and local transactions to finish. The amount of time to wait for is defined by the cache stop timeout.

locking

The locking mode for this cache, one of OPTIMISTIC or PESSIMISTIC.

Operations

remove

Removes a transaction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a transaction configuration element to the cache.

Request properties

Returns

Returned type:

eviction

The cache eviction configuration.

EVICTION

The cache eviction configuration.

Attributes

strategy

Sets the cache eviction strategy. Available options are 'UNORDERED', 'FIFO', 'LRU', 'LIRS' and 'NONE' (to disable eviction).

max-entries

Maximum number of entries in a cache instance. If selected value is not a power of two the actual value will default to the least power of two larger than selected value. -1 means no limit.

Operations

remove

Removes an eviction configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an eviction configuration element to the cache.

Request properties

Returns

Returned type:

expiration

The cache expiration configuration.

EXPIRATION

The cache expiration configuration.

Attributes

max-idle

Maximum idle time a cache entry will be maintained in the cache, in milliseconds. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means the entries never expire.

lifespan

Maximum lifespan of a cache entry, after which the entry is expired cluster-wide, in milliseconds. -1 means the entries never expire.

interval

Interval (in milliseconds) between subsequent runs to purge expired entries from memory and any cache stores. If you wish to disable the periodic eviction process altogether, set wakeupInterval to -1.

Operations

remove

Removes an expiration configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds an expiration configuration element to the cache.

Request properties

Returns

Returned type:

store

The cache store configuration.

STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

class

The custom store implementation class to use for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

file-store

The cache file store configuration.

FILE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

relative-to

Description

path

Description

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

string-keyed-jdbc-store

The string keyed cache JDBC store configuration.

STRING_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

binary-keyed-jdbc-store

The binary keyed cache JDBC store configuration.

BINARY_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

mixed-keyed-jdbc-store

The mixed keyed cache JDBC store configuration.

MIXED_KEYED_JDBC_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

datasource

A datasource reference for this datastore.

string-keyed-table

The database table used to store cache entries.

binary-keyed-table

The database table used to store binary cache entries.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

remote-store

The cache remote store configuration.

REMOTE_STORE

The cache store configuration.

Attributes

shared

This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

preload

If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

passivation

If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. f false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

fetch-state

If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

purge

If true, purges this cache store when it starts up.

singleton

If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

cache

The name of the remote cache to use for this remote store.

tcp-no-delay

A TCP_NODELAY value for remote cache communication.

socket-timeout

A socket timeout for remote cache communication.

remote-servers

A list of remote servers for this cache store.

Operations

remove

Removes a cache store configuration element from the cache.

Request properties

Returns

Returned type:

add

Adds a basic cache store configuration element to the cache.

Request properties

Returns

Returned type:

write-behind

Configures a cache store as write-behind instead of write-through.

WRITE_BEHIND

Configures a cache store as write-behind instead of write-through.

Attributes

flush-lock-timeout

Timeout to acquire the lock which guards the state to be flushed to the cache store periodically.

modification-queue-size

Maximum number of entries in the asynchronous queue. When the queue is full, the store becomes write-through until it can accept new entries.

thread-pool-size

Size of the thread pool whose threads are responsible for applying the modifications to the cache store.

shutdown-timeout

Timeout in milliseconds to stop the cache store.

Operations

remove

Removes a write-behind configuration element from the store.

Request properties

Returns

Returned type:

add

Adds a write-behind configuration element to the store.

Request properties

Returns

Returned type:

property

A cache store property with name and value.

*

A cache store property with name and value.

Attributes

value

The value of the cache store property.

Operations

remove

Removes a cache store property.

Request properties

Returns

Returned type:

add

Adds a cache store property.

Request properties

Returns

Returned type:

state-transfer

The state transfer configuration for distribution and replicated caches.

STATE_TRANSFER

The state transfer configuration for distribution and replicated caches.

Attributes

enabled

If enabled, this will cause the cache to ask neighboring caches for state when it starts up, so the cache starts 'warm', although it will impact startup time.

timeout

The maximum amount of time (ms) to wait for state from neighboring caches, before throwing an exception and aborting startup.

chunk-size

The size, in bytes, in which to batch the transfer of cache entries.

Operations

remove

Remove a state transfer configuration.

Request properties

Returns

Returned type:

add

Add a state transfer configuration.

Request properties

Returns

Returned type:

weld

The configuration of the weld subsystem.

Attributes

Operations

remove

Operation removing the weld subsystem.

Request properties

Returns

Returned type:

add

Operation creating the weld subsystem.

Request properties

Returns

Returned type:

osgi

The OSGi subsystem configuration

Attributes

activation

Activation flag for the OSGi subsystem. Possible values: lazy, eager

startlevel

The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly

Operations

activate

Activate the OSGi subsystem

Request properties

Returns

Returned type:

remove

Remove the OSGi subsystem configuration

Request properties

Returns

Returned type:

add

Add the OSGi subsystem configuration

Request properties

Returns

Returned type:

property

A framework property. The identity of the resource defines the property name

*

A framework property. The identity of the resource defines the property name

Attributes

value

The framework property value

Operations

remove

Remove a framework property

Request properties

Returns

Returned type:

add

Add a framework property

Request properties

Returns

Returned type:

capability

A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle

*

A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle

Attributes

startlevel

The startlevel for the capability. Can only be specified for OSGi bundles

Operations

remove

Remove a framework capability

Request properties

Returns

Returned type:

add

Add a framework capability

Request properties

Returns

Returned type:

bundle

Runtime bundle information. The resource can be identified by bundle id or bundle location

*

Runtime bundle information. The resource can be identified by bundle id or bundle location

Attributes

id

The bundle ID

startlevel

The bundle's start level

symbolic-name

The bundle symbolic name

version

The bundle version

state

State of bundle

type

Type of Bundle

location

The bundle location

Operations

stop

Stops a bundle

Request properties

Returns

Returned type:

start

Starts a bundle

Request properties

Returns

Returned type:

ejb3

The configuration of the ejb3 subsystem.

Attributes

default-mdb-instance-pool

Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level

default-entity-bean-optimistic-locking

If set to true entity beans will use optimistic locking by default

in-vm-remote-interface-invocation-pass-by-value

If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value.

default-clustered-sfsb-cache

Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level

default-entity-bean-instance-pool

Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level

default-distinct-name

The default distinct name that is applied to every EJB deployed on this server

default-singleton-bean-access-timeout

The default access timeout for singleton beans

default-sfsb-cache

Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level

default-resource-adapter-name

Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level

enable-statistics

If set to true, enable the collection of invocation statistics.

default-stateful-bean-access-timeout

The default access timeout for stateful beans

default-slsb-instance-pool

Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level

Operations

remove

Removes the ejb3 subsystem.

Request properties

Returns

Returned type:

add

Adds the ejb3 subsystem.

Request properties

Returns

Returned type:

service

Centrally configurable services that are part of the EJB3 subsystem.

async

The EJB3 Asynchronous Invocation Service

Attributes

thread-pool-name

The name of the thread pool which handles asynchronous invocations

Operations

remove

Removes the EJB3 Asynchronous Invocation Service

Request properties

Returns

Returned type:

add

Adds the EJB3 Asynchronous Invocation Service

Request properties

Returns

Returned type:

iiop

The IIOP service

Attributes

enable-by-default

If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor

use-qualified-name

If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)

Operations

remove

Removes IIOP support

Request properties

Returns

Returned type:

add

Adds IIOP support to the EJB3 subsystem

Request properties

Returns

Returned type:

remote

The EJB3 Remote Service

Attributes

thread-pool-name

The name of the thread pool that handles remote invocations

connector-ref

The name of the connector on which the EJB3 remoting channel is registered

Operations

remove

Removes the EJB3 remote service

Request properties

Returns

Returned type:

add

Adds the EJB3 remote service

Request properties

Returns

Returned type:

channel-creation-options

The options that will be used during the EJB remote channel creation

*

The options that will be used during the EJB remote channel creation

Attributes

value

The value for the EJB remote channel creation option

type

The type of the channel creation option

Operations

remove

Removes a EJB remote channel creation option

Request properties

Returns

Returned type:

add

Adds a EJB remote channel creation option

Request properties

Returns

Returned type:

timer-service

The EJB timer service

Attributes

path

The directory to store persistent timer information in

thread-pool-name

The name of the thread pool used to run timer service invocations

relative-to

The relative path that is used to resolve the timer data store location

Operations

remove

Removes the timer service

Request properties

Returns

Returned type:

add

Adds the timer service

Request properties

Returns

Returned type:

thread-pool

An EJB thread pool

*

A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.

Attributes

active-count

The approximate number of threads that are actively executing tasks.

current-thread-count

The current number of threads in the pool.

task-count

The approximate total number of tasks that have ever been scheduled for execution.

largest-thread-count

The largest number of threads that have ever simultaneously been in the pool.

keepalive-time

Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.

thread-factory

Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

completed-task-count

The approximate total number of tasks that have completed execution.

max-threads

The maximum thread pool size.

name

The name of the thread pool.

rejected-count

The number of tasks that have been rejected.

Operations

remove

Removes an unbounded thread pool.

Request properties

Returns

Returned type:

add

Adds an unbounded thread pool.

Request properties

Returns

Returned type:

file-passivation-store

A file system based passivation store

*

A file system based passivation store

Attributes

idle-timeout

The timeout in units specified by idle-timeout-unit, after which a bean will passivate

groups-path

sessions-path

relative-to

subdirectory-count

max-size

The maximum number of beans this cache should store before forcing old beans to passivate

idle-timeout-unit

The unit of idle-timeout

Operations

remove

Removes a file system based passivation store

Request properties

Returns

Returned type:

add

Adds a file system based passivation store

Request properties

Returns

Returned type:

strict-max-bean-instance-pool

A bean instance pool with a strict upper limit

*

A bean instance pool with a strict upper limit

Attributes

timeout-unit

The instance acquisition timeout unit

max-pool-size

The maximum number of bean instances that the pool can hold at a given point in time

timeout

The maximum amount of time to wait for a bean instance to be available from the pool

Operations

remove

Removes a specific a bean instance pool which has a strict upper limit for bean instances

Request properties

Returns

Returned type:

add

Adds a bean instance pool which has a strict upper limit for bean instances

Request properties

Returns

Returned type:

cache

A SFSB cache

*

A SFSB cache

Attributes

aliases

The aliases by which this cache may also be referenced

passivation-store

The passivation store used by this cache

Operations

remove

Removes a cache

Request properties

Returns

Returned type:

add

Adds a cache

Request properties

Returns

Returned type:

cluster-passivation-store

A clustered passivation store

*

A clustered passivation store

Attributes

idle-timeout

The timeout in units specified by idle-timeout-unit, after which a bean will passivate

cache-container

The name of the cache container used for the bean and client-mappings caches

client-mappings-cache

The name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings

bean-cache

The name of the cache used to store bean instances.

passivate-events-on-replicate

Indicates whether replication should trigger passivation events on the bean

max-size

The maximum number of beans this cache should store before forcing old beans to passivate

idle-timeout-unit

The unit of idle-timeout

Operations

remove

Removes a clustered passivation store

Request properties

Returns

Returned type:

add

Adds a clustered passivation store

Request properties

Returns

Returned type:

transactions

The configuration of the transaction subsystem.

Attributes

relative-to

References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.

process-id-uuid

Indicates whether the transaction manager should use a UUID based process id.

number-of-nested-transactions

The total number of nested (sub) transactions created.

socket-binding

Used to reference the correct socket binding to use for the recovery environment.

number-of-timed-out-transactions

The number of transactions that have rolled back due to timeout.

jts

If true this enables the Java Transaction Service

number-of-transactions

The total number of transactions (top-level and nested) created

object-store-path

Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.

path

Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute.

number-of-committed-transactions

The number of committed transactions.

number-of-heuristics

The number of transactions which have terminated with heuristic outcomes.

process-id-socket-binding

The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.

default-timeout

The default timeout.

number-of-aborted-transactions

The number of aborted (i.e. rolledback) transactions.

process-id-socket-max-ports

The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.

use-hornetq-store

Use the HornetQ journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log. The server should be restarted for this setting to take effect.

number-of-inflight-transactions

The number of transactions that have begun but not yet terminated.

recovery-listener

Used to specify if the recovery system should listen on a network socket or not.

number-of-application-rollbacks

The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behavior is considered an attribute of the application configuration.

status-socket-binding

Used to reference the correct socket binding to use for the transaction status manager.

node-identifier

Used to set the node identifier on the core environment.

enable-tsm-status

Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not..

object-store-relative-to

References a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the "path" attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the "path" attribute to be treated as an absolute path.

enable-statistics

Whether statistics should be enabled.

number-of-resource-rollbacks

The number of transactions that rolled back due to resource (participant) failure.

Operations

remove

Removes the transaction subsystem

Request properties

Returns

Returned type:

add

Adds the transaction subsystem

Request properties

Returns

Returned type:

log-store

Representation of the transaction logging storage mechanism.

log-store

Representation of the transaction logging storage mechanism.

Attributes

type

Specifies the implementation type of the logging store.

Operations

remove

Remove a representation of the transaction logging storage mechanism.

Request properties

Returns

Returned type:

add

Add a representation of the transaction logging storage mechanism.

Request properties

Returns

Returned type:

probe

Scan for new transaction logs. This operation will creates a child for each pending transaction.

Request properties

Returns

Returned type:

transactions

The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.

*

The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.

Attributes

id

The id of this transaction.

jmx-name

The JMX name of this transaction.

type

The type name under which this record is stored.

age-in-seconds

The time since this transaction was prepared or when the recovery system last tried to recover it.

Operations

delete

Remove this transaction log. WARNING after this operation the transaction manager will have no knowledge of the transaction and will therefore never be able to recover it. If you are sure that the transaction is complete then the operation is safe. The representation of the transaction log is removed from the model too.

Request properties

Returns

Returned type:

participants

The resources that did work in a transaction.

*

The resources that did work in a transaction.

Attributes

jmx-name

The JMX name of this participant.

eis-product-name

The JCA enterprise information system's product name.

status

Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).

eis-product-version

The JCA enterprise information system's product version

jndi-name

JNDI name of this participant.

type

The type name under which this record is stored.

Operations

refresh

Refresh the management view of the attributes of this participant record by querying the transaction log. (Note that the read-resource operaton only reads the model, hence the need for this refresh operation).

Request properties

Returns

Returned type:

recover

If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction.

Request properties

Returns

Returned type:

datasources

The data-sources subsystem, used to declare JDBC data-sources

Attributes

installed-drivers

List of JDBC drivers that have been installed in the runtime

Operations

installed-drivers-list

List of JDBC drivers that have been installed in the runtime

Request properties

Returns Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

Returned type: LIST

remove

Removes the data-sources subsystem

Request properties

Returns

Returned type:

get-installed-driver

Get a description of an installed driver

Request properties

Returns Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

Returned type: OBJECT

add

Adds the data-sources subsystem

Request properties

Returns

Returned type:

jdbc-driver

Service that make a JDBC driver available for use in the runtime

*

A service that makes a JDBC driver available for use in the runtime

Attributes

driver-name

The symbolic name of this driver used to reference it in the registry

deployment-name

The name of the deployment unit from which the driver was loaded

driver-module-name

The name of the module from which the driver was loaded, if it was loaded from the module path

module-slot

The slot of the module from which the driver was loaded, if it was loaded from the module path

driver-class-name

The fully qualified class name of the java.sql.Driver implementation

xa-datasource-class

The fully qualified class name of the javax.sql.XADataSource implementation

driver-major-version

The driver's major version number

driver-minor-version

The driver's minor version number

jdbc-compliant

Whether or not the driver is JDBC compliant

Operations

remove

Remove a JDBC driver

Request properties

Returns

Returned type:

add

Add a new JDBC driver

Request properties

Returns

Returned type:

data-source

A JDBC data-source configuration

ExampleDS

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

statistics

Runtime statistics provided by the resource adapter.

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the data-source

Request properties

Returns

Returned type:

enable

Enable the data-source

Request properties

Returns

Returned type:

disable

Disable the data-source

Request properties

Returns

Returned type:

add

Add a new data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

Operations

remove

Remove the connection property

Request properties

Returns

Returned type:

add

Add a connection property

Request properties

Returns

Returned type:

statistics

jdbc

Runtime statistics provided by the resource adapter.

Attributes

PreparedStatementCacheCurrentSize

The number of prepared and callable statements currently cached in the statement cache

PreparedStatementCacheMissCount

The number of times that a statement request could not be satisfied with a statement from the cache

PreparedStatementCacheAddCount

The number of statements added to the statement cache

PreparedStatementCacheAccessCount

The number of times that the statement cache was accessed

PreparedStatementCacheDeleteCount

The number of statements discarded from the cache

PreparedStatementCacheHitCount

The number of times that statements from the cache were used

Operations

clear-statistics

Clear statistics values for this resource

Request properties

Returns

Returned type:

pool

Runtime statistics provided by the resource adapter.

Attributes

AverageBlockingTime

The average time spent blocking for a connection

TimedOut

The timed out count

MaxWaitTime

The maximum wait time for a connection

ActiveCount

The active count

CreatedCount

The created count

TotalBlockingTime

The total blocking time

AverageCreationTime

The average time spent creating a physical connection

MaxCreationTime

The maximum time for creating a physical connection

TotalCreationTime

The total time spent creating physical connections

AvailableCount

The available count

MaxUsedCount

The maximum number of connections used

DestroyedCount

The destroyed count

Operations

clear-statistics

Clear statistics values for this resource

Request properties

Returns

Returned type:

*

A JDBC data-source configuration

Attributes

connection-url

The JDBC driver connection URL

driver-class

The fully qualified name of the JDBC driver class

datasource-class

The fully qualified name of the JDBC datasource class

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

jta

Enable JTA integration

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the data-source

Request properties

Returns

Returned type:

enable

Enable the data-source

Request properties

Returns

Returned type:

disable

Disable the data-source

Request properties

Returns

Returned type:

add

Add a new data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

connection-properties

The connection-properties element allows you to pass in arbitrary connection properties to the Driver.connect(url, props) method

*

value

Attributes

value

Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content

Operations

remove

Remove the connection property

Request properties

Returns

Returned type:

add

Add a connection property

Request properties

Returns

Returned type:

xa-data-source

A JDBC XA data-source configuration

*

A JDBC XA data-source configuration

Attributes

xa-datasource-class

The fully qualified name of the javax.sql.XADataSource implementation

jndi-name

Specifies the JNDI name for the datasource

driver-name

Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit

new-connection-sql

Specifies an SQL statement to execute whenever a connection is added to the connection pool

url-delimiter

Specifies the delimiter for URLs in connection-url for HA datasources

url-selector-strategy-class-name

A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy

use-java-context

Setting this to false will bind the datasource into global JNDI

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-prefill

Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

pad-xid

Should the Xid be padded

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

user-name

Specify the user name used when creating a new connection

password

Specifies the password used when creating a new connection

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

reauth-plugin-class-name

The fully qualified class name of the reauthentication plugin implementation

reauth-plugin-properties

The properties for the reauthentication plugin

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

allow-multiple-users

Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that

prepared-statements-cache-size

The number of prepared statements per connection in an LRU cache

share-prepared-statements

Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement

track-statements

Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

query-timeout

Any configured query timeout in seconds. If not provided no timeout will be set

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

set-tx-query-timeout

Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction

transaction-isolation

Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE

check-valid-connection-sql

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool

exception-sorter-class-name

An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error

exception-sorter-properties

The exception sorter properties

stale-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException

stale-connection-checker-properties

The stale connection checker properties

valid-connection-checker-class-name

An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element

valid-connection-checker-properties

The valid connection checker properties

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

validate-on-match

The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

spy

Enable spying of SQL statements

use-ccm

Enable the use of a cached connection manager

recovery-username

The user name used for recovery

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

no-recovery

Specifies if the connection pool should be excluded from recovery

jta

Enable JTA integration

enabled

Specifies if the datasource should be enabled

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the XA data-source

Request properties

Returns

Returned type:

enable

Enable the XA data-source

Request properties

Returns

Returned type:

disable

Disable the XA data-source

Request properties

Returns

Returned type:

add

Add a new XA data-source

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

xa-datasource-properties

List of xa-datasource-property

*

value

Attributes

value

Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor

Operations

remove

Remove the xa-datasource-property

Request properties

Returns

Returned type:

add

Add a single xa-datasource-property

Request properties

Returns

Returned type:

deployment-scanner

An individual deployment scanner that scans a particular location

Attributes

Operations

remove

Remove the deployment scanner subsystem.

Request properties

Returns

Returned type:

add

Add the deployment scanner subsystem.

Request properties

Returns

Returned type:

scanner

The scanners maintained by the subsystem.

*

The configuration of the deployment scanner subsystem

Attributes

relative-to

Reference to a filesystem path defined in the "paths" section of the server configuration.

path

The actual filesystem path to be scanned. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

auto-deploy-exploded

Allows the automatic deployment of exploded content without requiring a .dodeploy marker file. Recommended for only basic development scenarios to prevent exploded application deployment from occuring during changes by the developer or operating system.

auto-deploy-xml

Allows automatic deployment of XML content without requiring a .dodeploy marker file.

scan-enabled

Flag indicating that all scanning (including initial scanning at startup) should be disabled.

scan-interval

Periodic interval, in milliseconds, at which the repository should be scanned for changes. A value of less than 1 indicates the repository should only be scanned at initial startup.

auto-deploy-zipped

Allows automatic deployment of zipped content without requiring a .dodeploy marker file.

deployment-timeout

The time value in seconds for the deployment scanner to allow a deployment attempt before being cancelled.

Operations

remove

Remove a deployment scanner

Request properties

Returns

Returned type:

add

Add a new deployment scanner

Request properties

Returns

Returned type:

logging

The configuration of the logging subsystem.

Operations

remove

Remove the logging subsystem.

Request properties

Returns

Returned type:

add

Add the logging subsystem.

Request properties

Returns

Returned type:

root-logger

Defines the root logger for this log context.

ROOT

Defines the root logger for this log context.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

handlers

The Handlers associated with this Logger.

Operations

remove-root-logger

Remove the root logger.

Request properties

Returns

Returned type:

remove

Remove the root logger.

Request properties

Returns

Returned type:

root-logger-unassign-handler

Unassign a Handler from the root logger.

Request properties

Returns

Returned type:

change-root-log-level

Change the root logger level.

Request properties

Returns

Returned type:

set-root-logger

Set the root logger.

Request properties

Returns

Returned type:

root-logger-assign-handler

Assign a Handler to the root logger.

Request properties

Returns

Returned type:

add

Set the root logger.

Request properties

Returns

Returned type:

logger

Defines a logger category.

*

Defines a logger category.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

handlers

The Handlers associated with this Logger.

use-parent-handlers

Specifies whether or not this logger should send its output to it's parent Logger.

Operations

assign-handler

Assign a Handler to a Logger.

Request properties

Returns

Returned type:

remove

Remove an existing logger category.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a logger category.

Request properties

Returns

Returned type:

add

Add a new logger category.

Request properties

Returns

Returned type:

unassign-handler

Unassign a Handler from a Logger.

Request properties

Returns

Returned type:

async-handler

Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.

*

Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.

Attributes

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

queue-length

The queue length to use before flushing writing

overflow-action

Specify what action to take when the overflowing. The valid options are 'block' and 'discard'

subhandlers

The Handlers associated with this async handler.

encoding

The character encoding used by this Handler.

Operations

unassign-subhandler

Unassign a subhandler from the ASYNC handler.

Request properties

Returns

Returned type:

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing ASYNC handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

assign-subhandler

Assign a subhandler to the ASYNC handler.

Request properties

Returns

Returned type:

add

Add a new ASYNC handler.

Request properties

Returns

Returned type:

console-handler

Defines a handler which writes to the console.

*

Defines a handler which writes to the console.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

target

Defines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing console handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to the console.

Request properties

Returns

Returned type:

file-handler

Defines a handler which writes to a file.

*

Defines a handler which writes to a file.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to a file.

Request properties

Returns

Returned type:

periodic-rotating-file-handler

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

*

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

suffix

Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing periodic rotating file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string, which should be in a format understood by java.text.SimpleDateFormat.

Request properties

Returns

Returned type:

size-rotating-file-handler

Defines a handler which writes to a file, rotating the log after a the size of the file grows beyond a certain point and keeping a fixed number of backups.

*

Defines a handler which writes to a file, rotating the log after a the size of the file grows beyond a certain point and keeping a fixed number of backups.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

autoflush

Automatically flush after each write.

append

Specify whether to append to the target file.

file

The file description consisting of the path and optional relative to path.

rotate-size

The size at which to rotate the log file.

max-backup-index

The maximum number of backups to keep.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing size rotating file handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

change-file

Change the file for a handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Add a new size rotating file handler.

Request properties

Returns

Returned type:

custom-handler

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

*

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

Attributes

encoding

The character encoding used by this Handler.

level

The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.

filter

Defines a simple filter type.

formatter

Defines a formatter.

class

The logging handler class to be used.

module

The module that the logging handler depends on.

properties

Defines the properties used for the logging handler. All properties must be accessible via a setter method.

Operations

remove

Remove an existing logging handler.

Request properties

Returns

Returned type:

update-properties

Update the properties of an existing custom logging handler.

Request properties

Returns

Returned type:

enable

Enable a logging handler.

Request properties

Returns

Returned type:

disable

Disable a logging handler.

Request properties

Returns

Returned type:

change-log-level

Change the logging level for a handler.

Request properties

Returns

Returned type:

add

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

Request properties

Returns

Returned type:

jdr

JBoss Diagnostic Reporter (JDR) Subsystem.

Operations

remove

Removes the JDR subsystem.

Request properties

Returns

Returned type:

generate-jdr-report

Request the generation of a JDR report.

Request properties

Returns jdr.report.return

Returned type: OBJECT

add

Adds the JDR subsystem.

Request properties

Returns

Returned type:

messaging

The messaging subsystem.

Attributes

Operations

remove

Operation removing the messaging subsystem

Request properties

Returns

Returned type:

add

Operation adding the messaging subsystem

Request properties

Returns

Returned type:

jms-bridge

A JMS bridge instance.

*

A JMS bridge instance.

Attributes

selector

A JMS selector expression used for consuming messages from the source destination. Only messages that match the selector expression will be bridged from the source to the target destination.

failure-retry-interval

The amount of time in milliseconds to wait between trying to recreate connections to the source or target servers when the bridge has detected they have failed.

source-destination

The name of the source destination to lookup on the source messaging server.

quality-of-service

The desired quality of service mode (AT_MOST_ONCE, DUPLICATES_OK or ONCE_AND_ONLY_ONCE).

target-password

The password for creating the target connection.

max-batch-size

The maximum number of messages to consume from the source destination before sending them in a batch to the target destination. Its value must >= 1.

max-retries

The number of times to attempt to recreate connections to the source or target servers when the bridge has detected they have failed. The bridge will give up after trying this number of times. -1 represents 'try forever'.

client-id

The JMS client ID to use when creating/looking up the subscription if it is durable and the source destination is a topic.

source-password

The password for creating the source connection.

target-connection-factory

The name of the target connection factory to lookup on the target messaging server.

target-destination

The name of the target destination to lookup on the target messaging server.

module

The name of AS7 module containing the resources required to lookup source and target JMS resources.

source-context

he properties used to configure the source JNDI initial context.

paused

Whether the JMS bridge is paused.

source-connection-factory

The name of the source connection factory to lookup on the source messaging server.

add-messageID-in-header

If true, then the original message's message ID will be appended in the message sent to the destination in the header HORNETQ_BRIDGE_MSG_ID_LIST. If the message is bridged more than once, each message ID will be appended.

source-user

The name of the user for creating the source connection.

target-user

The name of the user for creating the target connection.

subscription-name

The name of the subscription if it is durable and the source destination is a topic.

max-batch-time

The maximum number of milliseconds to wait before sending a batch to target, even if the number of messages consumed has not reached max-batch-size. Its value must be -1 to represent 'wait forever', or >= 1 to specify an actual time.

started

Whether the JMS bridge is started.

target-context

The properties used to configure the target JNDI initial context.

Operations

pause

Pause the JMS bridge.

Request properties

Returns

Returned type:

stop

Stop the JMS bridge.

Request properties

Returns

Returned type:

resume

Resume the JMS bridge.

Request properties

Returns

Returned type:

remove

Remove an existing JMS bridge.

Request properties

Returns

Returned type:

start

Start the JMS bridge.

Request properties

Returns

Returned type:

add

Add a new JMS bridge.

Request properties

Returns

Returned type:

hornetq-server

A HornetQ server instance.

*

A HornetQ server instance.

Attributes

shared-store

Whether this server is using a shared store for failover.

thread-pool-max-size

The number of threads that the main thread pool has. -1 means no limit.

clustered

Whether the server is clustered.

remoting-interceptors

The list of interceptor classes used by this server.

create-bindings-dir

Whether the server should create the bindings directory on start up.

journal-buffer-size

The size of the internal buffer on the journal.

security-invalidation-interval

How long (in ms) to wait before invalidating the security cache.

message-counter-enabled

Whether message counters are enabled.

journal-type

The type of journal to use.

journal-sync-transactional

Whether to wait for transaction data to be synchronized to the journal before returning a response to the client.

journal-compact-min-files

The minimal number of journal data files before we can start compacting.

log-journal-write-rate

Whether to periodically log the journal's write rate and flush rate.

journal-max-io

The maximum number of write requests that can be in the AIO queue at any one time.

scheduled-thread-pool-max-size

The number of threads that the main scheduled thread pool has.

security-enabled

Whether security is enabled.

memory-warning-threshold

Percentage of available memory which if exceeded results in a warning log

journal-compact-percentage

The percentage of live data on which we consider compacting the journal.

failover-on-shutdown

Whether this backup server (if it is a backup server) should come live on a normal server shutdown.

cluster-user

The user used by cluster connections to communicate between the clustered nodes.

run-sync-speed-test

Whether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues.

jmx-domain

The JMX domain used to register internal HornetQ MBeans in the MBeanServer.

transaction-timeout

How long (in ms) before a transaction can be removed from the resource manager after create time.

cluster-password

The password used by cluster connections to communicate between the clustered nodes.

create-journal-dir

Whether the server should create the journal directory on start up.

message-counter-sample-period

The sample period (in ms) to use for message counters.

connection-ttl-override

If set, this will override how long (in ms) to keep a connection alive without receiving a ping.

persistence-enabled

Whether the server will use the file based journal for persistence.

allow-failback

Whether this server will automatically shutdown if the original live server comes back up.

transaction-timeout-scan-period

How often (in ms) to scan for timeout transactions.

persist-delivery-count-before-delivery

Whether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled.

page-max-concurrent-io

The maximum number of concurrent reads allowed on paging

journal-min-files

How many journal files to pre-create.

management-notification-address

The name of the address that consumers bind to to receive management notifications.

journal-buffer-timeout

The timeout (in nanoseconds) used to flush internal buffers on the journal.

version

The server's version.

management-address

Address to send management messages to.

journal-file-size

The size (in bytes) of each journal file.

journal-sync-non-transactional

Whether to wait for non transaction data to be synced to the journal before returning a response to the client.

persist-id-cache

Whether IDs are persisted to the journal.

backup

Whether this server is a backup server.

jmx-management-enabled

Whether HornetQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration.

async-connection-execution-enabled

Whether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread.

perf-blast-pages

TODO

memory-measure-interval

Frequency to sample JVM memory in ms (or -1 to disable memory sampling)

server-dump-interval

How often to dump basic runtime information to the server log. A value less than 1 disables this feature.

message-expiry-thread-priority

The priority of the thread expiring messages.

live-connector-ref

The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is "undefined".

failback-delay

How long to wait before failback occurs on live server restart.

id-cache-size

The size of the cache for pre-creating message IDs.

security-domain

The security domain to use to verify user and role information

message-expiry-scan-period

How often (in ms) to scan for expired messages.

wild-card-routing-enabled

Whether the server supports wild card routing.

message-counter-max-day-history

How many days to keep message counter history.

started

Whether this server is started.

Operations

get-session-creation-time

Gets the session's creation time.

Request properties

Returns The creation time, represented as a string showing the number of milliseconds since the epoch.

Returned type: STRING

remove

Operation removing a HornetQ server.

Request properties

Returns

Returned type:

list-remote-addresses

Lists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.

Request properties

Returns A list of strings, where the strings are remote client addresses.

Returned type: STRING

list-connection-ids

Lists the IDs of all the connections connected to this server.

Request properties

Returns A list of strings, where each string is a connection ID.

Returned type: LIST

add

Operation adding a HornetQ server.

Request properties

Returns

Returned type:

list-consumers-as-json

Lists all the consumers which belongs to the JMS Connection specified by the connection-id.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-connections-as-json

List all JMS connections.

Request properties

Returns The returned String is a JSON string containing an array of JMSConnectionInfo objects.

Returned type: STRING

commit-prepared-transaction

Heuristically commits a prepared transaction.

Request properties

Returns True if the transaction was successfully committed, false otherwise.

Returned type: BOOLEAN

get-last-sent-message-id

Returns the ID of the last message sent from the given session to the given address.

Request properties

Returns The message id.

Returned type: STRING

list-sessions

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns A list of strings, where each string is a session ID.

Returned type: STRING

list-target-destinations

Lists all addresses to which the designated session has sent messages.

Request properties

Returns The returned String is a JSON string containing an array of address names.

Returned type: STRING

list-prepared-transaction-details-as-html

List all the prepared transaction, sorted by date, oldest first, with details, in HTML format.

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-producers-info-as-json

For all sessions, lists information about message producers using JSON serialization.

Request properties

Returns The returned String is a JSON string containing an array of producer details.

Returned type: STRING

list-all-consumers-as-json

Lists all the consumers.

Request properties

Returns The returned String is a JSON string containing an array of JMSConsumerInfo objects.

Returned type: STRING

list-prepared-transaction-jms-details-as-json

List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

get-connectors-as-json

Returns the connectors configured for this server using JSON serialization.

Request properties

Returns A string in JSON format.

Returned type: STRING

reset-all-message-counters

Reset all message counters.

Request properties

Returns

Returned type:

list-prepared-transactions

List all the prepared transaction, sorted by date, oldest first.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions.

Returned type: LIST

list-sessions-as-json

Lists all the sessions IDs for the specified connection ID.

Request properties

Returns The returned String is a JSON string containing an array of session ids.

Returned type: STRING

list-prepared-transaction-jms-details-as-html

List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format

Request properties

Returns The returned String is an HTML string containing a table of transaction details.

Returned type: STRING

list-heuristic-committed-transactions

Lists transactions which have been heuristically committed.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

get-roles-as-json

Get the roles (as a JSON string) for a specific address match.

Request properties

Returns The returned String is a JSON string containing an array of security role details.

Returned type: STRING

reset-all-message-counter-histories

Reset all message counters history.

Request properties

Returns

Returned type:

get-roles

Get the security roles for a specific address match.

Request properties

Returns A list, each element of which is a set of properties describing a security role.

Returned type: LIST

list-prepared-transaction-details-as-json

List all the prepared transaction, sorted by date, oldest first, with details, in JSON format.

Request properties

Returns The returned String is a JSON string containing an array of transaction details.

Returned type: STRING

force-failover

Force the messaging server to stop and notify clients to failover.

Request properties

Returns

Returned type:

list-heuristic-rolled-back-transactions

Lists transactions which have been heuristically rolled back.

Request properties

Returns A list of strings. The Strings are Base-64 representation of the transaction XID.

Returned type: LIST

rollback-prepared-transaction

Heuristically rolls back a prepared transaction.

Request properties

Returns True if the transaction was successfully rolled back, false otherwise.

Returned type: BOOLEAN

close-connections-for-address

Closes all the connections of clients connected to this server whose remote address contains the specified IP address.

Request properties

Returns True if any connections were closed, false otherwise.

Returned type: BOOLEAN

get-address-settings-as-json

Returns the address settings as a JSON string for an address match.

Request properties

Returns The returned String is a JSON string containing an array of address settings details.

Returned type: STRING

in-vm-acceptor

Defines a way in which in-VM connections can be made to the HornetQ server.

*

Defines a way in which in-VM connections can be made to the HornetQ server.

Attributes

server-id

The server id.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

jms-queue

Defines a JMS queue.

*

Defines a JMS queue.

Attributes

entries

The jndi names the queue will be bound to.

selector

The queue selector.

durable

Whether the queue is durable or not.

queue-address

The queue address defines what address is used for routing messages.

expiry-address

The address to send expired messages to.

dead-letter-address

The address to send dead messages to.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

remove

Remove a JMS queue.

Request properties

Returns

Returned type:

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

add-jndi

Adds the queue to another JNDI binding

Request properties

Returns

Returned type:

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

add

Add a JMS queue.

Request properties

Returns

Returned type:

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

resume

Resume the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

security-setting

A security setting allows sets of permissions to be defined against queues based on their address.

*

A security setting allows sets of permissions to be defined against queues based on their address.

Operations

remove

Remove an existing security setting.

Request properties

Returns

Returned type:

add

Add new security setting.

Request properties

Returns

Returned type:

role

A security role.

*

A security role.

Attributes

send

This permission allows the user to send a message to matching addresses.

consume

his permission allows the user to consume a message from a queue bound to matching addresses.

create-durable-queue

This permission allows the user to create a durable queue.

delete-durable-queue

This permission allows the user to delete a durable queue.

create-non-durable-queue

This permission allows the user to create a temporary queue.

delete-non-durable-queue

This permission allows the user to delete a temporary queue.

manage

This permission allows the user to invoke management operations by sending management messages to the management address.

Operations

remove

Remove an existing security role.

Request properties

Returns

Returned type:

add

Add new security role.

Request properties

Returns

Returned type:

address-setting

An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.

*

An address setting defines some attributes that are defined against an address wildcard rather than a specific queue.

Attributes

address-full-policy

Determines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK)

dead-letter-address

The dead letter address

last-value-queue

Defines whether a queue only uses last values or not

max-delivery-attempts

Defines how many time a cancelled message can be redelivered before sending to the dead-letter-address

max-size-bytes

The max bytes size.

message-counter-history-day-limit

Day limit for the message counter history.

expiry-address

Defines where to send a message that has expired.

redelivery-delay

Defines how long to wait before attempting redelivery of a cancelled message

redistribution-delay

Defines how long to wait when the last consumer is closed on a queue before redistributing any messages

page-max-cache-size

The number of page files to keep in memory to optimize IO during paging navigation.

page-size-bytes

The paging size.

send-to-dla-on-no-route

If this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists.

Operations

remove

Operation removing an existing address-setting

Request properties

Returns

Returned type:

add

Operation adding an address-setting

Request properties

Returns

Returned type:

grouping-handler

Makes decisions about which node in a cluster should handle a message with a group id assigned.

*

Makes decisions about which node in a cluster should handle a message with a group id assigned.

Attributes

type

Whether the handler is the single "Local" handler for the cluster, which makes handling decisions, or a "Remote" handler which converses with the local handler.

grouping-handler-address

A reference to a cluster connection and the address it uses.

timeout

How long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept.

Operations

remove

Operation removing the grouping handler.

Request properties

Returns

Returned type:

add

Operation adding the grouping handler. Only one grouping handler is allowed.

Request properties

Returns

Returned type:

acceptor

An acceptor defines a way in which connections can be made to the HornetQ server.

*

An acceptor defines a way in which connections can be made to the HornetQ server.

Attributes

factory-class

The factory class.

socket-binding

The socket binding reference.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

jms-topic

Defines a JMS topic.

*

Defines a JMS topic.

Attributes

entries

The jndi names the topic will be bound to.

topic-address

The address the topic points to.

temporary

Whether the topic is temporary.

message-count

The number of messages currently in this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

durable-message-count

The number of messages for all durable subscribers for this topic.

non-durable-message-count

The number of messages for all non-durable subscribers for this topic.

subscription-count

The number of (durable and non-durable) subscribers for this topic.

durable-subscription-count

The number of durable subscribers for this topic.

non-durable-subscription-count

The number of non-durable subscribers for this topic.

Operations

list-durable-subscriptions-as-json

List only the durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

remove

Remove a JMS topic.

Request properties

Returns

Returned type:

list-non-durable-subscriptions

List only the non-durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

drop-all-subscriptions

Drop all subscriptions from this topic.

Request properties

Returns

Returned type:

add-jndi

Adds the queue to another JNDI binding

Request properties

Returns

Returned type:

list-messages-for-subscription

List all the messages for the given subscription.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

add

Add a JMS topic.

Request properties

Returns

Returned type:

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

list-durable-subscriptions

List only the durable subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

list-all-subscriptions-as-json

List all subscriptions as a string in JSON format.

Request properties

Returns

Returned type: STRING

list-non-durable-subscriptions-as-json

List only the non-durable subscriptions, as a string in JSON format.

Request properties

Returns

Returned type: STRING

drop-durable-subscription

Drop a durable subscription

Request properties

Returns

Returned type:

list-messages-for-subscription-as-json

List all the messages for the given subscription as a string in JSON format.

Request properties

Returns jms-topic.list-messages-for-subscription-as-json.reply

Returned type: STRING

count-messages-for-subscription

Count the number of messages matching the filter for the given subscription.

Request properties

Returns

Returned type: INT

list-all-subscriptions

List all subscriptions.

Request properties

Returns A list, each of whose elements describes a single subscription.

Returned type: LIST

in-vm-connector

Used by an in-VM client to define how it connects to a server.

*

Used by an in-VM client to define how it connects to a server.

Attributes

server-id

The server id.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

divert

A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.

*

A messaging resource that allows you to transparently divert messages routed to one address to some other address, without making any changes to any client application logic.

Attributes

divert-address

Address to divert from

exclusive

Whether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all.

routing-name

Routing name of the divert

forwarding-address

Address to divert to

filter

An optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.

transformer-class-name

The name of a class used to transform the message's body or properties before it is diverted.

Operations

remove

Operation removing a divert

Request properties

Returns

Returned type:

add

Operation adding a divert

Request properties

Returns

Returned type:

queue

A Queue.

*

A Queue.

Attributes

queue-address

The queue address defines what address is used for routing messages.

filter

A queue message filter definition. An undefined or empty filter will match all messages.

durable

Defines whether the queue is durable.

id

The id of the queue.

paused

Whether the queue is paused.

temporary

Whether the queue is temporary.

message-count

The number of messages currently in this queue.

scheduled-count

The number of scheduled messages in this queue.

consumer-count

The number of consumers consuming messages from this queue.

delivering-count

The number of messages that this queue is currently delivering to its consumers.

messages-added

The number of messages added to this queue since it was created.

Operations

remove

Operation removing an existing queue.

Request properties

Returns

Returned type:

list-scheduled-messages-as-json

List the messages scheduled for delivery as a string in JSON format.

Request properties

Returns A string in JSON format representing a list where each element is a map of message properties to their value.

Returned type: STRING

list-messages-as-json

List all messages in the queue that match the filter and return them as a string in JSON format.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: STRING

count-messages

Returns the number of the messages in the queue matching the given filter.

Request properties

Returns

Returned type: LONG

add

Operation adding a core queue.

Request properties

Returns

Returned type:

list-consumers-as-json

A string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

change-messages-priority

Change the priority of the messages corresponding to the given filter.

Request properties

Returns The number of removed messages.

Returned type: INT

pause

Pause the queue.

Request properties

Returns

Returned type:

list-message-counter-history-as-json

List the message counter history as a string in JSON format.

Request properties

Returns A string in JSON format

Returned type: STRING

expire-messages

Expire the messages matching the given filter.

Request properties

Returns The number of expired messages.

Returned type: INT

list-messages

List all messages in the queue that match the filter

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

move-message

Move the message corresponding to the given message-id to another queue

Request properties

Returns True if the message was moved, false otherwise

Returned type: BOOLEAN

reset-message-counter

Reset the message counters.

Request properties

Returns

Returned type:

send-message-to-dead-letter-address

Send the message corresponding to the given message-id to this queue's Dead Letter Address.

Request properties

Returns True if the message was sent to the dead letter address, false otherwise.

Returned type: BOOLEAN

expire-message

Expire the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

list-message-counter-as-json

List the message counter as a string in JSON format.

Request properties

Returns A string in JSON format.

Returned type: STRING

list-message-counter-as-html

List the message counter as a string in HTML format.

Request properties

Returns A string in HTML format.

Returned type: STRING

remove-messages

Remove messages matching the given filter from the destination.

Request properties

Returns The number of removed messages.

Returned type: INT

move-messages

Move the messages corresponding to the given filter to another queue.

Request properties

Returns The number of moved messages.

Returned type: INT

list-message-counter-history-as-html

List the message counter history.

Request properties

Returns A string in HTML format as a string in HTML format.

Returned type: STRING

list-scheduled-messages

List the messages scheduled for delivery.

Request properties

Returns A list where each element is a map of message properties to their value.

Returned type: LIST

resume

Resume the queue.

Request properties

Returns

Returned type:

send-messages-to-dead-letter-address

Send the messages corresponding to the given filter to this queue's Dead Letter Address.

Request properties

Returns The number of sent messages.

Returned type: INT

remove-message

Remove the message corresponding to the given message-id.

Request properties

Returns True if the message was removed, false otherwise.

Returned type: BOOLEAN

change-message-priority

Change the priority of the message corresponding to the given message-id.

Request properties

Returns True if the message was expired, false otherwise.

Returned type: BOOLEAN

core-address

A runtime-only resource representing a HornetQ "address". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.

*

A runtime-only resource representing a HornetQ "address". Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.

Attributes

roles

A list of the security roles (name and permissions) associated with the address.

queue-names

The names of the queues associated with the address.

number-of-bytes-per-page

The number of bytes used by each page for this address.

number-of-pages

The number of pages used by this address.

binding-names

The names of all bindings (both queues and diverts) bound to this address.

Operations

get-roles-as-json

Returns the roles (name and permissions) associated to this address using JSON serialization.

Request properties

Returns A string JSON format.

Returned type: STRING

pooled-connection-factory

Defines a managed connection factory.

*

Defines a managed connection factory.

Attributes

connector

Defines the connectors. These are stored in a map by connector name (with an undefined value).

entries

The jndi names the connection factory should be bound to.

auto-group

The autogroup.

block-on-acknowledge

True to set block on acknowledge.

block-on-durable-send

True to set block on durable send.

block-on-non-durable-send

True to set block on non durable send.

cache-large-message-client

True to cache large messages.

call-timeout

The call time out.

client-failure-check-period

The client failure check period.

client-id

The client id.

confirmation-window-size

The confirmation window size.

connection-ttl

The connection ttl.

consumer-max-rate

The consumer max rate.

consumer-window-size

The consumer window size.

discovery-group-name

The discovery group name.

discovery-initial-wait-timeout

The discovery initial wait time out.

dups-ok-batch-size

The dups ok batch size.

failover-on-initial-connection

True to fail over on initial connection.

failover-on-server-shutdown

True to fail over on server shutdown.

group-id

The group id.

ha

Whether the connection factory supports High Availability.

connection-load-balancing-policy-class-name

Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.

max-retry-interval

The max retry interval.

min-large-message-size

The min large message size.

password

The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

pre-acknowledge

True to pre-acknowledge.

producer-max-rate

The producer max rate.

producer-window-size

The producer window size.

reconnect-attempts

The reconnect attempts.

retry-interval

The retry interval.

retry-interval-multiplier

The retry interval multiplier.

scheduled-thread-pool-max-size

The scheduled thread pool max size.

thread-pool-max-size

The thread pool max size.

transaction-batch-size

The transaction batch size.

use-auto-recovery

True to use auto recovery.

use-global-pools

True to use global pools.

use-jndi

Use JNDI to locate the destination for incoming connections

user

The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host.

jndi-params

The JNDI params to use for locating the destination for incoming connections.

use-local-tx

Use a local transaction for incoming sessions

setup-attempts

The number of times to set up an MDB endpoint

setup-interval

The interval between attempts at setting up an MDB endpoint.

transaction

TODO

min-pool-size

The minimum size for the pool

max-pool-size

The maximum size for the pool

Operations

remove

Removes managed a connection factory.

Request properties

Returns

Returned type:

add

Adds a managed connection factory.

Request properties

Returns

Returned type:

connector

A connector can be used by a client to define how it connects to a server.

*

A connector can be used by a client to define how it connects to a server.

Attributes

factory-class

The factory class.

socket-binding

The socket binding reference.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

remote-acceptor

Defines a way in which remote connections can be made to the HornetQ server.

*

Defines a way in which remote connections can be made to the HornetQ server.

Attributes

socket-binding

The socket binding reference.

started

Whether this acceptor is started.

Operations

stop

Stops the acceptor.

Request properties

Returns

Returned type:

remove

Operation adding an acceptor

Request properties

Returns

Returned type:

start

Starts the acceptor.

Request properties

Returns

Returned type:

add

Operation adding an acceptor

Request properties

Returns

Returned type:

param

A key-value pair understood by the acceptor factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

remote-connector

Used by a remote client to define how it connects to a server.

*

Used by a remote client to define how it connects to a server.

Attributes

socket-binding

The socket binding reference.

Operations

remove

Operation removing a connector

Request properties

Returns

Returned type:

add

Operation adding a connector

Request properties

Returns

Returned type:

param

A key-value pair understood by the connector factory-class and used to configure it.

*

A parameter

Attributes

value

The parameter value

Operations

remove

Operation removing an existing parameter

Request properties

Returns

Returned type:

add

Operation adding a new parameter

Request properties

Returns

Returned type:

cluster-connection

Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.

*

Cluster connections group servers into clusters so that messages can be load balanced between the nodes of the cluster.

Attributes

cluster-connection-address

Each cluster connection only applies to messages sent to an address that starts with this value.

connector-ref

The confirmation-window-size to use for the connection used to forward messages to a target node.

min-large-message-size

The minimum size (in bytes) for a message before it is considered as a large message.

connection-ttl

The maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat).

retry-interval

The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.

retry-interval-multiplier

A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.

max-retry-interval

The maximum interval of time used to retry connections

reconnect-attempts

The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.

use-duplicate-detection

Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

check-period

The period (in milliseconds) between client failure check.

call-timeout

The timeout (in ms) for remote calls made by the cluster connection.

forward-when-no-consumers

Whether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then HornetQ will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message.

max-hops

The maximum number of times a message can be forwarded. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ servers as intermediates in a chain.

confirmation-window-size

The confirmation-window-size to use for the connection used to forward messages to a target node.

static-connectors

The statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined.

discovery-group-name

The discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined.

allow-direct-connections-only

Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined.

node-id

The node ID used by this cluster connection.

topology

The topology of the nodes that this cluster connection is aware of.

started

Whether the cluster connection is started.

Operations

stop

Stops the cluster connection.

Request properties

Returns

Returned type:

get-nodes

Returns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.

Request properties

Returns A map where keys are node IDs and values are the addresses used to connect to the nodes.

Returned type: OBJECT

remove

Operation removing a cluster connection

Request properties

Returns

Returned type:

start

Starts the cluster connection.

Request properties

Returns

Returned type:

get-static-connectors-as-json

Returns the list of static connectors as a string in JSON format.

Request properties

Returns

Returned type: STRING

add

Operation adding a cluster connection

Request properties

Returns

Returned type:

connection-factory

Defines a connection factory.

*

Defines a connection factory.

Attributes

connector

Defines the connectors. These are stored in a map by connector name (with an undefined value).

entries

The jndi names the connection factory should be bound to.

auto-group

Whether or not message grouping is automatically used

block-on-acknowledge

True to set block on acknowledge.

block-on-durable-send

True to set block on durable send.

block-on-non-durable-send

True to set block on non durable send.

cache-large-message-client

True to cache large messages.

call-timeout

The call time out.

client-failure-check-period

The client failure check period.

client-id

The client id.

compress-large-messages

Whether large messages should be compressed.

confirmation-window-size

The confirmation window size.

connection-ttl

The connection ttl.

consumer-max-rate

The consumer max rate.

consumer-window-size

The consumer window size.

discovery-group-name

The discovery group name.

discovery-initial-wait-timeout

The discovery initial wait time out.

dups-ok-batch-size

The dups ok batch size.

failover-on-initial-connection

True to fail over on initial connection.

failover-on-server-shutdown

True to fail over on server shutdown.

group-id

The group id.

ha

Whether the connection factory supports High Availability.

connection-load-balancing-policy-class-name

Name of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster.

max-retry-interval

The max retry interval.

min-large-message-size

The min large message size.

pre-acknowledge

True to pre-acknowledge.

producer-max-rate

The producer max rate.

producer-window-size

The producer window size.

reconnect-attempts

The reconnect attempts.

retry-interval

The retry interval.

retry-interval-multiplier

The retry interval multiplier.

scheduled-thread-pool-max-size

The scheduled thread pool max size.

thread-pool-max-size

The thread pool max size.

transaction-batch-size

The transaction batch size.

use-global-pools

True to use global pools.

factory-type

The type of connection factory.

initial-message-packet-size

The initial size of messages created through this factory.

Operations

remove

Removes a connection factory.

Request properties

Returns

Returned type:

add-jndi

Adds the factory to another JNDI binding

Request properties

Returns

Returned type:

add

Adds a connection factory.

Request properties

Returns

Returned type:

broadcast-group

A broadcast group is the means by which a server broadcasts connectors over the network.

*

A broadcast group is the means by which a server broadcasts connectors over the network.

Attributes

connectors

Specifies the names of connectors that will be broadcast.

group-address

The multicast address to which the data will be broadcast. It is a class D IP address in the range 224.0.0.0 to 239.255.255.255, inclusive. The address 224.0.0.0 is reserved and is not available for use.

group-port

The UDP port number used for broadcasting.

local-bind-address

The local bind address that the datagram socket is bound to. If you have multiple network interfaces on your server, you would specify which one you wish to use for broadcasts by setting this attribute. If this attribute is not specified then the socket will be bound to the wildcard address, an IP address chosen by the kernel.

started

Whether the broadcast group is started.

local-bind-port

The local port to which the datagram socket is bound. Normally you would just use the default value of -1 which signifies that an anonymous port should be used. This parameter is always specified in conjunction with local-bind-address.

socket-binding

The broadcast group socket binding.

broadcast-period

The period in milliseconds between consecutive broadcasts.

Operations

get-connector-pairs-as-json

Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.

Request properties

Returns

Returned type:

stop

Stops the broadcast group.

Request properties

Returns

Returned type:

remove

Remove a broadcast group.

Request properties

Returns

Returned type:

start

Starts the broadcast group.

Request properties

Returns

Returned type:

add

Add a broadcast group.

Request properties

Returns

Returned type:

path

A filesystem path pointing to one of the locations where HornetQ stores persistent data.

journal-directory

The directory in which the message journal lives. The default is ${jboss.server.data.dir}/messaging/journal.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

paging-directory

The directory where page files are stored. The default is ${jboss.server.data.dir}/messaging/paging.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

large-messages-directory

The directory in which large messages are stored. The default is ${jboss.server.data.dir}/messaging/largemessages.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

bindings-directory

The directory in which the bindings journal lives. The default is ${jboss.server.data.dir}/messaging/bindings.

Attributes

path

The actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.

If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:

If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.

relative-to

The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:

Operations

remove

Remove a path.

Request properties

Returns

Returned type:

add

Add a file system path.

Request properties

Returns

Returned type:

bridge

The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different HornetQ server.

*

The function of a bridge is to consume messages from a source queue, and forward them to a target address, typically on a different HornetQ server.

Attributes

min-large-message-size

The minimum size (in bytes) for a message before it is considered as a large message.

check-period

The period (in milliseconds) between client failure check.

failover-on-server-shutdown

Deprecated. Has no runtime effect and a warning will be issued if an attempt is made to set the value of this attribute.

retry-interval-multiplier

A multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts.

forwarding-address

The address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained.

transformer-class-name

The name of a user-defined class which implements the org.hornetq.core.server.cluster.Transformer interface.

ha

Whether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover.

reconnect-attempts

The total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts.

password

The password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used.

static-connectors

A list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined.

retry-interval

The period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed.

discovery-group-name

The name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined.

queue-name

The unique name of the local queue that the bridge consumes from.

use-duplicate-detection

Whether the bridge will automatically insert a duplicate id property into each message that it forwards.

max-retry-interval

The maximum interval of time used to retry connections

started

Whether the bridge is started.

confirmation-window-size

The confirmation-window-size to use for the connection used to forward messages to the target node.

user

The user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used.

filter

An optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the HornetQ filter expression syntax described in the HornetQ documentation.

connection-ttl

The maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat).

Operations

stop

Stops the bridge.

Request properties

Returns

Returned type:

remove

Operation removing a bridge.

Request properties

Returns

Returned type:

start

Starts the bridge.

Request properties

Returns

Returned type:

add

Operation adding a bridge.

Request properties

Returns

Returned type:

discovery-group

Multicast group to listen to receive broadcast from other servers announcing their connectors.

*

Multicast group to listen to receive broadcast from other servers announcing their connectors.

Attributes

refresh-timeout

Period the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list.

group-address

Multicast IP address of the group to listen on.

group-port

UDP port of the multicast group.

local-bind-address

The local bind address that the datagram socket is bound to.

socket-binding

The discovery group socket binding.

initial-wait-timeout

Period, in ms, to wait for an initial broadcast to give us at least one node in the cluster.

Operations

remove

Remove a discovery group.

Request properties

Returns

Returned type:

add

Add a discovery group.

Request properties

Returns

Returned type:

connector-service

TODO

*

TODO

Attributes

factory-class

Class name of the factory class that can instantiate the connector service.

Operations

remove

Operation removing a connector service

Request properties

Returns

Returned type:

add

Operation adding a connector service

Request properties

Returns

Returned type:

param

A key/value pair understood by the connector service's factory-class

*

A key/value pair understood by the connector service's factory-class

Attributes

value

Value portion of a key/value pair understood by the connector service's factory-class

Operations

remove

Removes a key/value pair understood by the connector service's factory-class

Request properties

Returns

Returned type:

add

Adds a key/value pair understood by the connector service's factory-class

Request properties

Returns

Returned type:

pojo

Support JBoss5 and JBoss6 pojo configuration model.

Attributes

Operations

remove

Remove pojo subsystem

Request properties

Returns

Returned type:

add

Add pojo subsystem

Request properties

Returns

Returned type:

jpa

The configuration of the JPA subsystem.

Attributes

default-datasource

The name of the default global datasource.

Operations

remove

Remove the JPA subsystem.

Request properties

Returns

Returned type:

add

Add the JPA subsystem.

Request properties

Returns

Returned type:

naming

The configuration of the naming subsystem.

Attributes

Operations

remove

Removes the naming subsystem.

Request properties

Returns

Returned type:

jndi-view

Dump the local JNDI tree

Request properties

Returns

Returned type:

add

Adds the naming subsystem.

Request properties

Returns

Returned type:

binding

JNDI bindings for primitive types

*

JNDI bindings for primitive types

Attributes

module

The module to load the object factory from for object factory bindings

environment

The environment to use on object factory instance retrieval

binding-type

The type of binding to create, may be simple, lookup or object-factory

value

The value to bind for simple bindings

class

The object factory class name for object factory bindings

type

The type of the value to bind for simple bindings, this must be a primitive type

lookup

The entry to lookup in JNDI for lookup bindings

Operations

remove

Removes a JNDI binding

Request properties

Returns

Returned type:

add

Adds a JNDI binding

Request properties

Returns

Returned type:

service

Naming based services

remote-naming

The remote naming server

Attributes

Operations

remove

Removes the remote naming server

Request properties

Returns

Returned type:

add

Adds the remote naming server

Request properties

Returns

Returned type:

ee

The configuration of the EE subsystem.

Attributes

global-modules

A list of modules that should be made available to all deployments.

spec-descriptor-property-replacement

Flag indicating whether descriptors defined by the Java EE specification will have property replacements applied

jboss-descriptor-property-replacement

Flag indicating whether JBoss specific deployment descriptors will have property replacements applied

ear-subdeployments-isolated

Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.

Operations

remove

Removes the EE subsystem.

Request properties

Returns

Returned type:

add

Adds the EE subsystem.

Request properties

Returns

Returned type:

mail

The mail subsystem

Attributes

Operations

remove

Removes the mail subsystem

Request properties

Returns

Returned type:

add

Adds the mail subsystem

Request properties

Returns

Returned type:

mail-session

Mail session definition

*

Mail session definition

Attributes

jndi-name

JNDI name to where mail session should be bound

debug

Enables JavaMail debugging

from

From address that is used as default from, if not set when sending

Operations

remove

Adds a mail session

Request properties

Returns

Returned type:

add

Adds a mail session

Request properties

Returns

Returned type:

server

Mail session server

pop3

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

imap

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

smtp

Mail session server

Attributes

outbound-socket-binding-ref

Outbound Socket binding to mail server

ssl

Does server require SSL?

username

Username to authenticate on server

password

Password to authenticate on server

Operations

remove

removes server

Request properties

Returns

Returned type:

add

adds mail server

Request properties

Returns

Returned type:

web

The configuration of the jboss.web subsystem.

Attributes

default-virtual-server

The web container's default virtual server.

instance-id

Set the identifier for this server instance.

native

Add the native initialization listener to the web container.

Operations

remove

Operation removing the web subsystem.

Request properties

Returns

Returned type:

add

Operation adding the web subsystem.

Request properties

Returns

Returned type:

configuration

The common web container configuration.

container

Common container configuration

Attributes

mime-mapping

A mime-mapping definition.

welcome-file

A welcome files declaration.

Operations

add-mime

Adds mime type

Request properties

Returns

Returned type:

remove

Removes web container

Request properties

Returns

Returned type:

remove-mime

Remove mime type

Request properties

Returns

Returned type:

add

Adds web container

Request properties

Returns

Returned type:

static-resources

Static files serving configuration.

Attributes

sendfile

Enable sendfile if possible, for files bigger than the specified byte size.

max-depth

Maximum recursion for PROPFIND.

read-only

Allow write HTTP methods (PUT, DELETE).

webdav

Enable WebDAV functionality.

secret

Secret for WebDAV locking operations.

file-encoding

Force a file encoding.

listings

Enable folder listings.

disabled

Disables the default Servlet mapping.

Operations

remove

Remove static configuration

Request properties

Returns

Returned type:

add

Add static configuration

Request properties

Returns

Returned type:

jsp-configuration

JSP container configuration.

Attributes

trim-spaces

Trim some spaces from the generated Servlet.

source-vm

Source VM level for compilation.

development

Enable the development mode, which gives more information when an error occurs.

keep-generated

Keep the generated Servlets.

recompile-on-fail

Retry failed JSP compilations on each request.

check-interval

Check interval for JSP updates using a background thread.

modification-test-interval

Minimum amount of time between two tests for updates, in seconds.

scratch-dir

Specify a different work directory.

display-source-fragment

When a runtime error occurs, attempts to display corresponding JSP source fragment.

error-on-use-bean-invalid-class-attribute

Enable errors when using a bad class in useBean.

java-encoding

Specify the encoding used for Java sources.

tag-pooling

Enable tag pooling.

generate-strings-as-char-arrays

Generate String constants as char arrays.

target-vm

Target VM level for compilation.

x-powered-by

Enable advertising the JSP engine in x-powered-by.

dump-smap

Write SMAP data to a file.

mapped-file

Map to the JSP source.

disabled

Enable the JSP container.

smap

Enable SMAP.

Operations

remove

Removes JSP container configuration.

Request properties

Returns

Returned type:

add

Adds JSP container configuration.

Request properties

Returns

Returned type:

virtual-server

A virtual host.

*

A virtual host.

Attributes

enable-welcome-root

Whether or not the bundled welcome directory is used as the root web context.

default-web-module

The web module deployment name that will be mapped as the root webapp.

alias

The virtual server aliases

name

A unique virtual host name

Operations

remove

Remove an existing virtual-server

Request properties

Returns

Returned type:

add

Add a new virtual-server

Request properties

Returns

Returned type:

configuration

configuration of virutal server

sso

The SSO configuration for this virtual server.

Attributes

domain

The cookie domain that will be used.

cache-container

Enables clustered SSO using the specified clustered cache container.

reauthenticate

Enables reauthentication with the realm when using SSO.

cache-name

Name of the cache to use in the cache container.

Operations

remove

Erase the SSO configuration from the virtual server.

Request properties

Returns

Returned type:

add

Add a SSO configuration for this virtual server.

Request properties

Returns

Returned type:

access-log

The access log configuration for this virtual server.

Attributes

pattern

The access log pattern.

rotate

Rotate the access log every day.

prefix

Prefix for the log file name.

extended

Enable extended pattern, with more options.

resolve-hosts

Host resolution.

Operations

remove

Remove access log configuration from this virtual server.

Request properties

Returns

Returned type:

add

Add access log configuration to this virtual server.

Request properties

Returns

Returned type:

directory

The location for the access logging.

setting

Settings for access log

directory

The location for the access logging.

Attributes

path

The relative folder path.

relative-to

The folder the path is relative to.

Operations

remove

Removes directory

Request properties

Returns

Returned type:

add

Adds directory

Request properties

Returns

Returned type:

rewrite

A list of rewrite rules that will be processed in order on the URL or vhost specified in the request.

*

A list of rewrite rules that will be processed in order on the URL or vhost specified in the request.

Attributes

substitution

The string that will replace the original URL or vhost.

flags

Option flags for this rewrite rule.

pattern

The pattern that will be matched.

Operations

remove

Remove a rule from the list of rewrite rules.

Request properties

Returns

Returned type:

add

Add a rule to the list of rewrite rules.

Request properties

Returns

Returned type:

condition

A list of conditions this rule needs to match for rewrite to occur.

*

A list of conditions this rule needs to match for rewrite to occur.

Attributes

flags

Option flags for this condition.

pattern

The pattern to match.

test

Test pattern for the condition.

Operations

remove

Remove a condition from the list of conditions of the rule.

Request properties

Returns

Returned type:

add

Add a condition to the list of conditions of the rule.

Request properties

Returns

Returned type:

sso

The SSO configuration for this virtual server.

access-log

The access log configuration for this virtual server.

connector

A web connector.

*

A web connector.

Attributes

bytesSent

Number of byte sent by the connector.

proxy-port

The port that will be used when sending a redirect.

secure

Indicates if content sent or received by the connector is secured from the user perspective.

virtual-server

The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers.

errorCount

Number of error that occurs when processing requests by the connector.

maxTime

Max time spent to process a requests.

socket-binding

The web connector socket-binding reference, this connector should be bound to.

scheme

The web connector scheme.

name

A unique name for the connector.

max-post-size

Maximum size in bytes of a POST request that can be parsed by the container.

requestCount

Number of the request processed by the connector.

proxy-name

The host name that will be used when sending a redirect. The default value is null.

enabled

Defines whether the connector should be started on startup.

protocol

The web connector protocol.

enable-lookups

Enable DNS lookups for Servlet API.

executor

The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool.

processingTime

Processing time used by the connector. Im milli-seconds.

redirect-port

The port for redirection to a secure connector.

bytesReceived

Number of byte received by the connector (POST data).

max-connections

Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used.

max-save-post-size

Maximum size in bytes of a POST request that will be saved during certain authentication schemes.

Operations

remove

Remove an existing web connector

Request properties

Returns

Returned type:

add

Add a new web connector.

Request properties

Returns

Returned type:

ssl

The SSL configuration of the connector.

configuration

Various additional configuration

ssl

The SSL configuration of the connector.

Attributes

key-alias

The key alias.

verify-depth

Limit certificate nesting.

protocol

The SSL protocols that are enabled.

cipher-suite

The allowed cipher suite.

certificate-file

Server certificate file.

ca-certificate-password

Certificate password.

ca-certificate-file

Certificate authority.

session-cache-size

SSL session cache.

password

Password.

session-timeout

SSL session cache timeout.

ca-revocation-url

Certificate authority revocation list.

truststore-type

Type of the truststore, There are various types of keystores available, including "PKCS12" and Sun's "JKS."

name

The configuration name.

certificate-key-file

Key file for the certificate.

verify-client

Enable client certificate verification.

keystore-type

Type of the keystore, There are various types of keystores available, including "PKCS12" and Sun's "JKS."

Operations

remove

Remove the SSL configuration of the connector.

Request properties

Returns

Returned type:

add

Add an SSL configuration of the connector.

Request properties

Returns

Returned type:

cmp

The configuration of the cmp subsystem.

Attributes

Operations

remove

Removes the cmp subsystem.

Request properties

Returns

Returned type:

add

Adds the cmp subsystem.

Request properties

Returns

Returned type:

uuid-keygenerator

UUID based key generators

*

UUID based key generators

Attributes

Operations

remove

Remove a UUID key generator

Request properties

Returns

Returned type:

add

Add a UUID key generator

Request properties

Returns

Returned type:

hilo-keygenerator

HiLo based key generators

*

HiLo based key generators

Attributes

block-size

The block size

sequence-name

The name of the sequence

sequence-column

The sequence column name

create-table

Boolean to determine whether to create create the tables

data-source

The datasource used for sequence generation

select-hi-ddl

The DDL used to select the hi value

drop-table

Boolean to determine whether to create drop the tables

create-table-ddl

The DDL used to create the table

id-column

The ID column name

table-name

The table name

Operations

remove

Remove a HiLo key generator

Request properties

Returns

Returned type:

add

Add a HiLo key generator

Request properties

Returns

Returned type:

jsr77

The configuration of the JSR-77 subsystem.

Attributes

Operations

remove

Removes the jSR-77 subsystem.

Request properties

Returns

Returned type:

add

Adds the JSR-77 subsystem.

Request properties

Returns

Returned type:

resource-adapters

Configuration of the resource adapters subsystem

Operations

remove

Removes the resource adapters subsystem

Request properties

Returns

Returned type:

add

Adds the resource adapters subsystem

Request properties

Returns

Returned type:

resource-adapter

The configuration of a resource adapter

*

resource-adapter

Attributes

archive

Specifies the resource adapter archive

transaction-support

Specifies the transaction support level of the resource adapter

bootstrap-context

Specifies the unique name of the bootstrap context that should be used

config-properties

Custom defined config properties

beanvalidationgroups

Specifies the bean validation groups that should be used

Operations

activate

Force the resource adapter config activation without server reload

Request properties

Returns

Returned type:

remove

Remove the resource adapter

Request properties

Returns

Returned type:

add

Add a new resource adapter

Request properties

Returns

Returned type:

connection-definitions

Specifies the connection definitions

*

connection-definitions

Attributes

class-name

Specifies the fully qualified class name of a managed connection factory or admin object

jndi-name

Specifies the JNDI name for the connection factory or admin object

use-java-context

Setting this to false will bind the object into global JNDI

enabled

Specifies if the resource adapter should be enabled

max-pool-size

The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool

min-pool-size

The min-pool-size element specifies the minimum number of connections for a pool

pool-use-strict-min

Specifies if the min-pool-size should be considered strictly

flush-strategy

Specifies how the pool should be flush in case of an error. Valid values are: FailingConnectionOnly (default), IdleConnections and EntirePool

security-domain-and-application

Indicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool

security-application

Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool

security-domain

Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool

allocation-retry

The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception

allocation-retry-wait-millis

The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection

blocking-timeout-wait-millis

The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time

idle-timeout-minutes

The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.

xa-resource-timeout

The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero

use-try-lock

Any configured timeout for internal locks on the resource adapter objects in seconds

background-validation-millis

The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart

background-validation

An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart

use-fast-fail

Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)

use-ccm

Enable the use of a cached connection manager

recovery-plugin-class-name

The fully qualified class name of the recovery plugin implementation

recovery-plugin-properties

The properties for the recovery plugin

recovery-password

The password used for recovery

recovery-security-domain

The security domain used for recovery

recovery-username

The user name used for recovery

no-recovery

Specifies if the connection pool should be excluded from recovery

wrap-xa-resource

Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance

same-rm-override

The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false

pad-xid

Should the Xid be padded

pool-prefill

Should the pool be prefilled. Changing this value requires a server restart

interleaving

An element to enable interleaving for XA connections

no-tx-separate-pool

Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts

Operations

test-connection-in-pool

Test if a connection can be obtained

Request properties

Returns

Returned type:

remove

Remove the connection definition

Request properties

Returns

Returned type:

add

Add a connection definition

Request properties

Returns

Returned type:

flush-idle-connection-in-pool

Flushes all idle connections in the pool

Request properties

Returns

Returned type:

flush-all-connection-in-pool

Flushes all connections in the pool

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

admin-objects

Specifies the administration objects

*

admin-objects

Attributes

class-name

Specifies the fully qualified class name of a managed connection factory or admin object

jndi-name

Specifies the JNDI name for the connection factory or admin object

use-java-context

Setting this to false will bind the object into global JNDI

enabled

Specifies if the resource adapter should be enabled

Operations

remove

Remove the administration object

Request properties

Returns

Returned type:

add

Add an administration object

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

config-properties

Custom defined config properties

*

config-properties

Attributes

value

Custom defined config property value

Operations

remove

Remove the custom defined config property

Request properties

Returns

Returned type:

add

Add a custom defined config property

Request properties

Returns

Returned type:

security

The configuration of the security subsystem.

Attributes

deep-copy-subject-mode

Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads.

Operations

remove

Removes the security subsystem.

Request properties

Returns

Returned type:

add

Adds the security subsystem.

Request properties

Returns

Returned type:

security-domain

Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.

*

Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.

Attributes

cache-type

Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.

Operations

remove

Remove a security domain.

Request properties

Returns

Returned type:

list-cached-principals

Lists the principals stored in the authentication cache for this security domain.

Request properties

Returns list-cached-principals.return

Returned type: LIST

add

Add a security domain.

Request properties

Returns

Returned type:

flush-cache

Remove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.

Request properties

Returns

Returned type:

identity-trust

Identity trust configuration. Configures a list of trust modules to be used.

classic

Identity trust configuration. Configures a list of trust modules to be used.

Attributes

trust-modules

List of trust modules

Operations

remove

Removes an identity trust configuration.

Request properties

Returns

Returned type:

add

Adds an identity trust configuration.

Request properties

Returns

Returned type:

authentication

"Authentication configuration for this domain. Can either be classic or jaspi.

classic

Traditional authentication configuration. Configures a list of login modules to be used.

Attributes

login-modules

List of authentication modules

Operations

remove

Removes a traditional authentication configuration

Request properties

Returns

Returned type:

add

Adds a traditional authentication configuration

Request properties

Returns

Returned type:

jaspi

JASPI authentication configuration.

Attributes

auth-modules

List of authentication modules to be used.

Operations

remove

Removes a JASPI authentication configuration

Request properties

Returns

Returned type:

add

Adds a JASPI authentication configuration

Request properties

Returns

Returned type:

login-module-stack

List of "named" login modules that are used by jaspi authentication modules.

*

List of "named" login modules that are used by jaspi authentication modules.

Attributes

login-modules

List of authentication modules

Operations

remove

Removes a named login module stack configuration

Request properties

Returns

Returned type:

add

Adds a named login module stack configuration

Request properties

Returns

Returned type:

acl

Access control list configuration. Configures a list of ACL modules to be used.

classic

Access control list configuration. Configures a list of ACL modules to be used.

Attributes

acl-modules

List of acl modules

Operations

remove

Removes an ACL configuration

Request properties

Returns

Returned type:

add

Adds an ACL configuration

Request properties

Returns

Returned type:

audit

Auditing configuration. Configures a list of provider modules to be used.

classic

Auditing configuration. Configures a list of provider modules to be used.

Attributes

provider-modules

List of provider modules

Operations

remove

Removes and audit configuration

Request properties

Returns

Returned type:

add

Adds an audit configuration

Request properties

Returns

Returned type:

mapping

Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.

classic

Mapping configuration. Configures a list of mapping modules to be used for principal, role, attribute and credential mapping.

Attributes

mapping-modules

List of modules that map principal, role, and credential information

Operations

remove

Removes a mapping configuration.

Request properties

Returns

Returned type:

add

Adds a mapping configuration.

Request properties

Returns

Returned type:

jsse

JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.

classic

JSSE configuration. Configures attributes for keystores that can be used for setting up SSL.

Attributes

client-auth

Boolean attribute to indicate if client's certificates should also be authenticated on the server side.

protocols

Comma separated list of protocols to enable on SSLSockets.

truststore

Configures a JSSE trust store

trust-manager

JSEE Trust Manager factory

key-manager

JSEE Key Manager factory

service-auth-token

Token to retrieve PrivateKeys from the KeyStore.

keystore

Configures a JSSE key store

additional-properties

Additional properties that may be necessary to configure JSSE.

server-alias

Preferred alias to use when the KeyManager chooses the server alias.

client-alias

Preferred alias to use when the KeyManager chooses the client alias.

cipher-suites

Comma separated list of cipher suites to enable on SSLSockets.

Operations

remove

Removes a JSSE configuration.

Request properties

Returns

Returned type:

add

Adds a JSSE configuration

Request properties

Returns

Returned type:

authorization

Authorization configuration. Configures a list of authorization policy modules to be used.

classic

Authorization configuration. Configures a list of authorization policy modules to be used.

Attributes

policy-modules

List of authorization modules

Operations

remove

Removes an authorization configuration

Request properties

Returns

Returned type:

add

Adds an authorization configuration

Request properties

Returns

Returned type:

vault

Security Vault for attributes.

classic

Security Vault for attributes.

Attributes

vault-options

Security Vault options.

code

Fully Qualified Name of the Security Vault Implementation.

Operations

remove

Removes a security vault configuration

Request properties

Returns

Returned type:

add

Adds a security vault configuration

Request properties

Returns

Returned type: